Struct StateRevision 

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

Positive monotonically increasing state revision.

Revisions belong to individual keys. They are not global commit ids, workflow sequence numbers, or historical snapshot selectors. Puts and deletes increment the key revision; tombstones retain it across recreation. The positive u64 representation does not promise every backend can persist its full range.

Examples

use storage_kit::state::record::StateRevision;
let revision = StateRevision::new(3)?;
assert_eq!(revision.get(), 3);
assert!(StateRevision::new(0).is_err());

Implementations

impl StateRevision

pub fn new(value: u64) -> Result<Self, StateStoreError>

Validates a positive revision.

This validates a representation; it does not assign a revision to stored data.

Errors

Returns StateStoreError::InvalidRequest when value is zero.

Examples

use storage_kit::state::record::StateRevision;
assert!(StateRevision::new(0).is_err());
assert_eq!(StateRevision::new(1)?, StateRevision::first());

pub fn first() -> Self

Returns revision one.

Examples

use storage_kit::state::record::StateRevision;
assert_eq!(StateRevision::first().get(), 1);

pub fn get(self) -> u64

Returns the revision value.

Examples

use storage_kit::state::record::StateRevision;
assert_eq!(StateRevision::new(8)?.get(), 8);

Trait Implementations

impl Clone for StateRevision

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StateRevision

impl Debug for StateRevision

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

Formats the value using the given formatter.

impl Eq for StateRevision

impl Hash for StateRevision

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 StateRevision

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StateRevision

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for StateRevision