Struct hydroflow::scheduled::ticks::TickDuration

pub struct TickDuration {
    pub ticks: i64,
}

The duration between two ticks.

TickDuration instances can be negative to allow for calculation of TickInstant instances in the past.

assert_eq!(TickInstant(1) + TickDuration::new(-1), TickInstant(0))

TickDuration instances can be added/subtracted to/from other TickDuration instances

assert_eq!(TickDuration::ZERO + TickDuration::ZERO, TickDuration::ZERO);
assert_eq!(
    TickDuration::ZERO + TickDuration::SINGLE_TICK,
    TickDuration::SINGLE_TICK
);
assert_eq!(
    TickDuration::SINGLE_TICK - TickDuration::ZERO,
    TickDuration::SINGLE_TICK
);
assert_eq!(
    TickDuration::SINGLE_TICK - TickDuration::SINGLE_TICK,
    TickDuration::ZERO
);
assert_eq!(
    TickDuration::ZERO - TickDuration::SINGLE_TICK,
    -TickDuration::SINGLE_TICK
);

Fields

ticks: i64

The length of the duration, measured in ticks.

Implementations

impl TickDuration

pub const ZERO: Self = _

A zero duration

It is the identity element for addition for both TickDuration and TickInstant (i.e. adding zero duration to a TickInstant or TickDuration results in the same TickInstant or TickDuration.

let ticks = TickInstant::new(100);
assert_eq!(ticks + TickDuration::ZERO, ticks);
assert_eq!(ticks - TickDuration::ZERO, ticks);

let duration = TickDuration::new(100);
assert_eq!(duration + TickDuration::ZERO, duration);
assert_eq!(duration - TickDuration::ZERO, duration);

pub const SINGLE_TICK: Self = _

A single tick duration.

It is the duration between two consecutive TickInstant instances.

assert_eq!(TickInstant(0) + TickDuration::SINGLE_TICK, TickInstant(1))

pub fn new(ticks: i64) -> TickDuration

Create a new TickDuration for the specified tick interval.

A negative duration allows for calculating TickInstants in the past and represents a backward movement in time.

Trait Implementations

impl Add<TickDuration> for TickInstant

type Output = TickInstant

The resulting type after applying the + operator.

fn add(self, rhs: TickDuration) -> Self::Output

Performs the + operation.

impl Add for TickDuration

type Output = TickDuration

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<TickDuration> for TickInstant

fn add_assign(&mut self, rhs: TickDuration)

Performs the += operation.

impl AddAssign for TickDuration

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for TickDuration

fn clone(&self) -> TickDuration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TickDuration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TickDuration

fn default() -> TickDuration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TickDuration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TickDuration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<TickDuration> for i64

fn from(value: TickDuration) -> Self

Converts to this type from the input type.

impl Hash for TickDuration

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Neg for TickDuration

type Output = TickDuration

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for TickDuration

fn cmp(&self, other: &TickDuration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TickDuration

fn eq(&self, other: &TickDuration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TickDuration

fn partial_cmp(&self, other: &TickDuration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TickDuration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<TickDuration> for TickInstant

type Output = TickInstant

The resulting type after applying the - operator.

fn sub(self, rhs: TickDuration) -> Self::Output

Performs the - operation.

impl Sub for TickDuration

type Output = TickDuration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<TickDuration> for TickInstant

fn sub_assign(&mut self, rhs: TickDuration)

Performs the -= operation.

impl SubAssign for TickDuration

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for TickDuration

impl Eq for TickDuration

impl StructuralPartialEq for TickDuration