Struct s2n_quic_core::time::Timestamp

pub struct Timestamp(_);

An absolute point in time.

The absolute value of Timestamps should be treated as opaque. It is not necessarily related to any calendar time. Timestamps should only be compared if they are are sourced from the same clock.

Timestamps are similar to the Instant data-type in the Rust standard library, but can be created even without an available standard library.

The size of Timestamp is guaranteed to be consistent across platforms.

Implementations

impl Timestamp

pub fn checked_add(self, duration: Duration) -> Option<Self>

Tries to calculate a Timestamp based on the current Timestamp and adding the provided Duration. If this Timestamp is representable within the range of Timestamp it is returned as Some(timestamp). Otherwise None is returned.

pub fn checked_sub(self, duration: Duration) -> Option<Self>

Tries to calculate a Timestamp based on the current Timestamp and subtracting the provided Duration. If this Timestamp is representable within the range of Timestamp it is returned as Some(timestamp). Otherwise None is returned.

pub fn saturating_duration_since(self, earlier: Self) -> Duration

Returns the Duration which elapsed since an earlier Timestamp. If earlier is more recent, the method returns a Duration of 0.

pub unsafe fn from_duration(duration: Duration) -> Self

Creates a Timestamp from a Duration since the time source’s epoch. This will treat the duration as an absolute point in time.

Safety

This should only be used by time sources

pub unsafe fn as_duration(self) -> Duration

Converts the Timestamp into the Duration since the time source’s epoch.

Safety

This should only be used by time sources

pub const fn has_elapsed(self, now: Self) -> bool

Compares the timestamp to the current time and returns true if it is in the past

Note that this compares milliseconds, as any finer resolution would result in excessive timer churn.

Trait Implementations

impl Add<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl AddAssign<Duration> for Timestamp

fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl Hash for Timestamp

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 IntoEvent<Timestamp> for Timestamp

fn into_event(self) -> Timestamp

impl Ord for Timestamp

fn cmp(&self, other: &Timestamp) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Timestamp> for Timestamp

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

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

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

This method tests for !=.

impl PartialOrd<Timestamp> for Timestamp

fn partial_cmp(&self, other: &Timestamp) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

impl Sub<Timestamp> for Timestamp

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Timestamp) -> Self::Output

Performs the - operation.

impl SubAssign<Duration> for Timestamp

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralEq for Timestamp

impl StructuralPartialEq for Timestamp