Struct EpochBoundaries 

pub struct EpochBoundaries(/* private fields */);

Stores the epoch boundaries.

The representation stored is a map between the epoch and the sequence number of the respective last checkpoint.

Examples

let boundaries: EpochBoundaries = [(0, 5), (1, 100), (2, 1000)].into_iter().collect();
assert_eq!(boundaries.get(1), Some(100));
// The last checkpoints of a range of epochs, in epoch order.
assert_eq!(
    boundaries.range(..2).collect::<Vec<_>>(),
    vec![(0, 5), (1, 100)]
);

Implementations

impl EpochBoundaries

pub fn get(&self, epoch: EpochId) -> Option<CheckpointSequenceNumber>

Returns the boundary of the given epoch.

pub fn range( &self, range: impl RangeBounds<EpochId>, ) -> impl Iterator<Item = (EpochId, CheckpointSequenceNumber)> + '_

Returns the recorded (epoch, last checkpoint) pairs for the epochs in range, in epoch order.

pub fn contains(&self, epoch: EpochId) -> bool

Returns whether the given epoch has a recorded boundary.

pub fn insert_next( &mut self, epoch: EpochId, boundary: CheckpointSequenceNumber, ) -> Result<()>

Inserts a new epoch boundary, keeping the recorded epochs contiguous. Any existing boundary for the same epoch is overwritten.

Errors

Fails if the previous epoch has not been already recorded.

pub fn file_path() -> Path

The relative path of the file with the serialized boundaries.

Trait Implementations

impl Clone for EpochBoundaries

fn clone(&self) -> EpochBoundaries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochBoundaries

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

Formats the value using the given formatter.

impl Default for EpochBoundaries

fn default() -> EpochBoundaries

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EpochBoundaries

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<(u64, u64)> for EpochBoundaries

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = (EpochId, CheckpointSequenceNumber)>,

Creates a value from an iterator.

impl PartialEq for EpochBoundaries

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

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 EpochBoundaries

impl StructuralPartialEq for EpochBoundaries