Struct Epoch 

pub struct Epoch<Ts = u128>
where
    Ts: RawTimestamp,
{ /* private fields */ }

An Epoch represents a span of time defined by a starting Timestamp and a size in units of time (e.g., seconds, minutes, hours). The size indicates the duration of the epoch and is used to determine when the epoch ends.

Implementations

impl<Ts> Epoch<Ts>

where Ts: RawTimestamp,

pub const fn new(size: u128, timestamp: Ts) -> Epoch<Ts>

returns a new instance of the Epoch using the given size and timestamp.

pub const fn size(&self) -> u128

The size of the epoch; epochs generally consider the number of steps, or size, (e.g. the number of seconds) that will need to be taken before the epoch is considered to be complete and a new one begins.

pub const fn timestamp(&self) -> &Timestamp<Ts>

returns an immutable reference to the timestamp

pub fn set_size(&mut self, size: u128)

update the size of the epoch

pub fn with_size(self, size: u128) -> Epoch<Ts>

consumes the current instance to create another with the given size and current timestamp.

pub fn with_timestamp<U>(self, timestamp: U) -> Epoch<U>

where U: RawTimestamp,

consumes the current instance to create another with the given timestamp and current size.

Trait Implementations

impl<Ts> Clone for Epoch<Ts>

where Ts: Clone + RawTimestamp,

fn clone(&self) -> Epoch<Ts>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Ts> Debug for Epoch<Ts>

where Ts: Debug + RawTimestamp,

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

Formats the value using the given formatter.

impl<'de, Ts> Deserialize<'de> for Epoch<Ts>

where Ts: RawTimestamp + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Epoch<Ts>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Ts> Hash for Epoch<Ts>

where Ts: Hash + RawTimestamp,

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

where __H: Hasher,

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<Ts> Ord for Epoch<Ts>

where Ts: Ord + RawTimestamp,

fn cmp(&self, other: &Epoch<Ts>) -> 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<Ts> PartialEq for Epoch<Ts>

where Ts: PartialEq + RawTimestamp,

fn eq(&self, other: &Epoch<Ts>) -> 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<Ts> PartialOrd for Epoch<Ts>

where Ts: PartialOrd + RawTimestamp,

fn partial_cmp(&self, other: &Epoch<Ts>) -> 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<Ts> Serialize for Epoch<Ts>

where Ts: RawTimestamp + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Ts> Copy for Epoch<Ts>

where Ts: Copy + RawTimestamp,

impl<Ts> Eq for Epoch<Ts>

where Ts: Eq + RawTimestamp,

impl<Ts> StructuralPartialEq for Epoch<Ts>

where Ts: RawTimestamp,