Struct SeqMarked 

pub struct SeqMarked<D = Vec<u8>> { /* private fields */ }

Sequence-numbered marked value.

Ordered by sequence number first, then tombstone > normal.

use seq_marked::SeqMarked;

let v1 = SeqMarked::new_normal(1, "data");
let v2 = SeqMarked::<&str>::new_tombstone(2);
assert!(v1 < v2);

Implementations

impl SeqMarked<()>

pub const fn zero() -> Self

Creates the smallest order key (seq=0, normal).

pub const fn max_value() -> Self

impl<D> SeqMarked<&D>

pub fn cloned(self) -> SeqMarked<D>

where D: Clone,

impl<D> SeqMarked<D>

pub fn new(seq: u64, marked: Marked<D>) -> Self

Creates a new SeqMarked with sequence number and marked data.

pub fn new_normal(seq: u64, data: D) -> Self

Creates normal value with sequence number.

pub fn new_tombstone(seq: u64) -> Self

Creates tombstone with sequence number.

pub fn new_not_found() -> Self

Represents an absent record (not even marked as deleted).

pub fn to_tombstone(self) -> Self

pub fn is_normal(&self) -> bool

Returns true if this is normal data.

pub fn is_tombstone(&self) -> bool

Returns true if this is a tombstone.

pub fn is_not_found(&self) -> bool

pub fn is_absent(&self) -> bool

pub fn map<U>(self, f: impl FnOnce(D) -> U) -> SeqMarked<U>

Transforms data D to U while preserving sequence and tombstone state.

Example

use seq_marked::SeqMarked;

let a = SeqMarked::new_normal(1, "data");
let b = a.map(|x| x.len());
assert_eq!(b.data_ref(), Some(&4));

pub fn try_map<U, E>( self, f: impl FnOnce(D) -> Result<U, E>, ) -> Result<SeqMarked<U>, E>

pub fn as_ref(&self) -> SeqMarked<&D>

Creates reference to the data.

pub fn order_key(&self) -> SeqMarked<()>

Returns ordering key (sequence + tombstone state only).

pub fn internal_seq(&self) -> InternalSeq

Returns the sequence number for internal use, tombstone also has a seq.

pub fn user_seq(&self) -> u64

Returns the sequence number for application use, tombstone always has seq 0.

pub fn max(a: Self, b: Self) -> Self

Returns the maximum of two values.

pub fn max_ref<'l>(a: &'l Self, b: &'l Self) -> &'l Self

Returns the maximum of two values.

pub fn data_ref(&self) -> Option<&D>

Returns reference to data if normal, None if tombstone.

pub fn into_data(self) -> Option<D>

Consumes and returns data if normal, None if tombstone.

pub fn into_parts(self) -> (u64, Marked<D>)

pub fn display_with_debug(&self) -> impl Display + '_

where D: Debug,

Returns formatter for display using Debug trait.

Trait Implementations

impl<D: Clone> Clone for SeqMarked<D>

fn clone(&self) -> SeqMarked<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for SeqMarked<D>

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

Formats the value using the given formatter.

impl<D> Display for SeqMarked<D>

where D: Display,

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

Formats the value using the given formatter.

impl<D> From<SeqData<D>> for SeqMarked<D>

fn from(value: SeqData<D>) -> Self

Converts to this type from the input type.

impl<M> From<SeqMarked<(Option<M>, String)>> for SeqMarked<(Option<M>, Vec<u8>)>

fn from(value: SeqMarked<(Option<M>, String)>) -> Self

Converts to this type from the input type.

impl<M, T> From<SeqMarked<(Option<M>, T)>> for Option<SeqV<M, T>>

fn from(value: SeqMarked<(Option<M>, T)>) -> Self

Converts to this type from the input type.

impl<D> From<SeqMarked<D>> for Option<SeqData<D>>

fn from(value: SeqMarked<D>) -> Self

Converts to this type from the input type.

impl<M, T> From<SeqV<M, T>> for SeqMarked<(Option<M>, T)>

fn from(value: SeqV<M, T>) -> Self

Converts to this type from the input type.

impl<D: Ord> Ord for SeqMarked<D>

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

fn eq(&self, other: &SeqMarked<D>) -> 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<D: PartialOrd> PartialOrd for SeqMarked<D>

fn partial_cmp(&self, other: &SeqMarked<D>) -> 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<M, T> SeqValue<M, T> for SeqMarked<(Option<M>, T)>

SeqMarked is a superset of SeqValue.

fn seq(&self) -> u64

Return the sequence number of the value.

fn value(&self) -> Option<&T>

Return the reference of the value.

fn into_value(self) -> Option<T>

Consume the value and return the value.

fn meta(&self) -> Option<&M>

Return the reference of metadata of the value.

fn unpack(self) -> (u64, Option<V>)

where Self: Sized,

Consume self and return the sequence number and the value.

fn expires_at_ms_opt(&self) -> Option<u64>

where M: Expirable,

Return the absolute expire time in millisecond since 1970-01-01 00:00:00.

fn expires_at_ms(&self) -> u64

where M: Expirable,

Returns the absolute expiration time in milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).

fn is_expired(&self, now_ms: u64) -> bool

where M: Expirable,

Return true if the record is expired at the given time in milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).

impl<M> TryFrom<SeqMarked<(Option<M>, Vec<u8>)>> for SeqMarked<(Option<M>, String)>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SeqMarked<(Option<M>, Vec<u8>)>) -> Result<Self, Self::Error>

Performs the conversion.

impl<D: Copy> Copy for SeqMarked<D>

impl<D: Eq> Eq for SeqMarked<D>

impl<D> StructuralPartialEq for SeqMarked<D>