Struct Cursor 

pub struct Cursor {
    pub timestamp: u64,
    pub message_id: BroadcastMessageID,
}

A cursor for paginating broadcast messages.

Fields

timestamp: u64

message_id: BroadcastMessageID

Implementations

impl Cursor

pub fn new(timestamp: u64, message_id: BroadcastMessageID) -> Self

pub fn go_back_for_some_time(&self, duration: Duration) -> Self

Create a new cursor which is the same as the current cursor but with a smaller timestamp. This is useful when we want to query messages back from this cursor for a certain duration.

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

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

pub fn max() -> Self

A dummy cursor with the maximum timestamp and a dummy message id. This is useful when we want to create a cursor after which none of the messages should be included.

pub fn is_max(&self) -> bool

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type.

impl From<Cursor> for Cursor

fn from(cursor: Cursor) -> Self

Converts to this type from the input type.

impl Hash for Cursor

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 Cursor

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.

impl PartialEq for Cursor

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

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 TryFrom<Cursor> for Cursor

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cursor: Cursor) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Cursor

impl StructuralPartialEq for Cursor