Skip to main content

EventNumbers

Struct EventNumbers 

Source
pub struct EventNumbers { /* private fields */ }
Expand description

The node’s event-number counter (§7.14.1.1).

Hands out numbers from RAM and tells the caller when to persist the next reservation, so that monotonicity survives a restart without a flash write per event.

Implementations§

Source§

impl EventNumbers

Source

pub const fn restore(persisted: u64) -> Self

Resumes from the value that was last persisted.

§7.14.1.1’s step 1 and 2: “Read the counter value at start-up. Before processing any message, write counter + N to storage.” So a fresh boot starts at the persisted value and immediately owes a write of persisted + N — which EventNumbers::reservation reports.

Source

pub const fn reservation(&self) -> Option<u64>

The value the node must persist before handing out any more numbers.

None when the current reservation still has room. A caller that ignores this breaks the monotonicity guarantee only across a restart — which is exactly the kind of bug that never shows up in testing.

Source

pub const fn reserved(&mut self, value: u64)

Records that value has been durably stored.

Source

pub const fn next(&mut self) -> Option<u64>

Takes the next event number.

Returns None while a reservation is owed: handing out a number the node has not reserved is precisely how a restart rewinds the counter, and a record with a reused number tells a client that nothing happened when something did.

Source

pub const fn peek(&self) -> u64

The number the next event will take.

Trait Implementations§

Source§

impl Clone for EventNumbers

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EventNumbers

Source§

impl Debug for EventNumbers

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EventNumbers

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for EventNumbers

Source§

impl PartialEq for EventNumbers

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EventNumbers

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.