Struct Id 

pub struct Id {
    pub ms: u64,
    pub seq: u64,
}

An entry ID, which is a millisecond and a sequence number inside it.

Two 64 bit halves rather than one 128 bit number, because both halves are addressable on the wire: XADD key 5-* asks for the next sequence inside millisecond five, and XRANGE key 5 5 is every sequence inside it.

Fields

ms: u64

The millisecond, which is a unix timestamp for an ID the server made up.

seq: u64

Which entry within that millisecond.

Implementations

impl Id

pub const MIN: Id

The lowest ID there is, which is what - means in a range.

pub const MAX: Id

The highest, which is what + means.

pub const fn new(ms: u64, seq: u64) -> Id

An ID from its two halves.

pub const fn next(self) -> Option<Id>

The next ID after this one, or None at Id::MAX.

What an exclusive range start turns into, and what XADD key ms-* resolves to when the millisecond is already the last one used.

pub const fn prev(self) -> Option<Id>

The ID before this one, or None at Id::MIN.

pub fn to_bytes(self) -> [u8; 16]

The sixteen big endian bytes Redis keys a node by.

Big endian because that is the order that sorts, which is the whole reason the format picked it.

pub fn from_bytes(bytes: [u8; 16]) -> Id

The ID those bytes hold.

pub fn write_to(self, out: &mut Vec<u8>)

ms-seq, which is how an ID looks everywhere a client can see one.

pub fn to_vec(self) -> Vec<u8>

The same as a fresh Vec, for a caller that is not building a reply.

pub fn parse(s: &[u8], default: u64) -> Option<Id>

ms or ms-seq, with a missing sequence read as default.

XRANGE key 5 5 means every entry in millisecond five, so the start defaults its sequence to zero and the end to the largest there is. The special forms a client can send, -, +, $, * and ms-*, are the command layer’s business and not this one’s.

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Id

impl Debug for Id

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

Formats the value using the given formatter.

impl Default for Id

fn default() -> Id

Returns the “default value” for a type.

impl Eq for Id

impl Ord for Id

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Id

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