Struct StreamVersion 

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

How many events a ceremony’s stream holds.

A stream that does not exist yet is at StreamVersion::EMPTY; after that the version is the sequence of the last record, since sequences start at 1 and are contiguous. A command is decided against a version and appended with it as the expectation, which is what lets a store refuse a write decided against a stream that has since moved on.

Not a super::AuditSequence: a sequence names a record, and there is no record for an empty stream.

Implementations

impl StreamVersion

pub const EMPTY: Self

The version of a stream nothing has been appended to.

pub const fn new(value: u64) -> Self

pub fn from_sequence(sequence: AuditSequence) -> Self

The version a stream reaches once sequence is its last record.

pub fn value(self) -> u64

pub fn next(self) -> Self

The version after one more event. Saturates rather than wrapping, as sequences do.

pub fn is_empty(self) -> bool

Trait Implementations

impl Clone for StreamVersion

fn clone(&self) -> StreamVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamVersion

impl Debug for StreamVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamVersion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamVersion

impl Hash for StreamVersion

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

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 Ord for StreamVersion

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for StreamVersion

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StreamVersion

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamVersion