Struct RefreshSchedule

pub struct RefreshSchedule {
    pub everies: Vec<RefreshEvery>,
    pub ats: Vec<Timestamp>,
}

Fields

everies: Vec<RefreshEvery>

ats: Vec<Timestamp>

Implementations

impl RefreshSchedule

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

Rounds up the timestamp to the time of the next refresh. Returns None if there is no next refresh. It saturates, i.e., if the next refresh would be larger than the maximum timestamp, then it returns the maximum timestamp. Note that this function is monotonic.

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

Rounds down timestamp - 1 to the time of the previous refresh. Returns None if there is no previous refresh. It saturates, i.e., if the previous refresh would be smaller than the minimum timestamp, then it returns the minimum timestamp. Note that this fn is monotonic.

pub fn last_refresh(&self) -> Option<Timestamp>

Returns the time of the last refresh. Returns None if there is no last refresh (e.g., for a periodic refresh).

(If there is no last refresh, then we have a REFRESH EVERY, in which case the saturating roundup puts a refresh at the maximum possible timestamp. This means that it would make some sense to return the maximum possible timestamp instead of None. Indeed, some of our callers handle our None return value in exactly this way. However, some other callers do something else with None, and therefore we don’t want to hardcode this behavior in this function.)

pub fn is_empty(&self) -> bool

Returns whether the schedule is empty, i.e., no EVERY or AT.

Trait Implementations

impl Arbitrary for RefreshSchedule

type Strategy = BoxedStrategy<RefreshSchedule>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for RefreshSchedule

fn clone(&self) -> RefreshSchedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshSchedule

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

Formats the value using the given formatter.

impl Default for RefreshSchedule

fn default() -> RefreshSchedule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RefreshSchedule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for RefreshSchedule

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

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

fn partial_cmp(&self, other: &RefreshSchedule) -> 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 RustType<ProtoRefreshSchedule> for RefreshSchedule

fn into_proto(&self) -> ProtoRefreshSchedule

Convert a Self into a Proto value.

fn from_proto(proto: ProtoRefreshSchedule) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for RefreshSchedule

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 RefreshSchedule

impl StructuralPartialEq for RefreshSchedule