Struct ValueSeqNum 

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

Value sequence number

Implementations

impl ValueSeqNum

pub const MAX: Self

The largest representable sequence number (u32::MAX is reserved to mean ValueSeqNum::NONE)

pub const NONE: Self

No sequence number, for a subkey that has never been written

pub const ZERO: Self

The sequence number of a subkey’s first write

impl ValueSeqNum

pub fn next(&self) -> VeilidAPIResult<Self>

The next sequence number, starting at ValueSeqNum::ZERO from ValueSeqNum::NONE. Fails at ValueSeqNum::MAX.

pub const fn is_max(&self) -> bool

True if this is ValueSeqNum::MAX

pub const fn is_none(&self) -> bool

True if this is ValueSeqNum::NONE

pub const fn is_some(&self) -> bool

True if this holds a sequence number

pub const fn to_option(&self) -> Option<u32>

The sequence number as an Option, None for ValueSeqNum::NONE

Trait Implementations

impl Clone for ValueSeqNum

fn clone(&self) -> ValueSeqNum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ValueSeqNum

impl Debug for ValueSeqNum

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

Formats the value using the given formatter.

impl Default for ValueSeqNum

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ValueSeqNum

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ValueSeqNum

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

Formats the value using the given formatter.

impl Eq for ValueSeqNum

impl From<Option<u32>> for ValueSeqNum

fn from(value: Option<u32>) -> Self

Converts to this type from the input type.

impl From<ValueSeqNum> for u32

fn from(value: ValueSeqNum) -> Self

Converts to this type from the input type.

impl From<ValueSeqNum> for Option<u32>

fn from(value: ValueSeqNum) -> Self

Converts to this type from the input type.

impl From<u32> for ValueSeqNum

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for ValueSeqNum

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 ValueSeqNum

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ValueSeqNum

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

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 ValueSeqNum

impl ToVeilidAPIErrorArgument for ValueSeqNum

fn to_veilid_api_error_argument(&self) -> String

Render this value as a string for inclusion in a VeilidAPIError message field.