Struct pubnub_core::data::timetoken::Timetoken

pub struct Timetoken {
    pub t: u64,
    pub r: u32,
}

PubNub Timetoken

This is the timetoken structure that PubNub uses as a stream index. It allows clients to resume streaming from where they left off for added resiliency.

Fields

t: u64

Timetoken

r: u32

Origin region

Methods

impl Timetoken

pub fn new(time: SystemTime, region: u32) -> Result<Self, SystemTimeError>

Create a Timetoken.

Arguments

• time - A SystemTime representing when the message was received by the PubNub global network.
• region - An internal region identifier for the originating region.

region may be set to 0 if you have nothing better to use. The combination of a time and region gives us a vector clock that represents the message origin in spacetime; when and where the message was created. Using an appropriate region is important for delivery semantics in a global distributed system.

Errors

Returns an error when the input time argument cannot be transformed into a duration.

Example

use pubnub_core::data::timetoken::Timetoken;
use std::time::SystemTime;

let now = SystemTime::now();
let timetoken = Timetoken::new(now, 0)?;

Trait Implementations

impl Clone for Timetoken

fn clone(&self) -> Timetoken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Timetoken

impl Debug for Timetoken

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

Formats the value using the given formatter.

impl Default for Timetoken

#[must_use]fn default() -> Self

Returns the "default value" for a type.

impl Display for Timetoken

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Timetoken

impl Hash for Timetoken

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Timetoken> for Timetoken

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Timetoken

impl StructuralPartialEq for Timetoken