Struct RefreshEvery

pub struct RefreshEvery {
    pub interval: Duration,
    pub aligned_to: Timestamp,
}

Fields

interval: Duration

aligned_to: Timestamp

Implementations

impl RefreshEvery

pub fn round_up_timestamp(&self, timestamp: Timestamp) -> Timestamp

Rounds up the timestamp to the time of the next refresh, according to the given periodic refresh schedule. It saturates, i.e., if the rounding would make it overflow, then it returns the maximum possible timestamp.

Panics

• if the refresh interval converted to milliseconds cast to u64 overflows;
• if the interval is 0. (These should be checked in HIR planning.)

pub fn round_down_timestamp_m1(&self, timestamp: Timestamp) -> Timestamp

Rounds down timestamp - 1 to the time of the previous refresh, according to the given periodic refresh schedule. It saturates, i.e., if the rounding would make it underflow, then it returns the minimum possible timestamp.

Panics

• if the refresh interval converted to milliseconds cast to u64 overflows;
• if the interval is 0. (These should be checked in HIR planning.)

fn round_up_to_multiple_of_interval(interval: u64, x: u64) -> u64

Rounds up x to the nearest multiple of interval. x must not be 0.

It saturates, i.e., if the rounding would make it overflow, then it returns the maximum possible timestamp.

fn round_down_to_multiple_of_interval(interval: u64, x: u64) -> u64

Rounds down x to the nearest multiple of interval.

Trait Implementations

impl Clone for RefreshEvery

fn clone(&self) -> RefreshEvery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshEvery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RefreshEvery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for RefreshEvery

fn cmp(&self, other: &RefreshEvery) -> 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,

Restrict a value to a certain interval.

impl PartialEq for RefreshEvery

fn eq(&self, other: &RefreshEvery) -> 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 RefreshEvery

fn partial_cmp(&self, other: &RefreshEvery) -> 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 RefreshEvery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RefreshEvery

impl StructuralPartialEq for RefreshEvery