Struct Timestamp 

pub struct Timestamp(/* private fields */);

A Willow Timestamp is a 64-bit unsigned integer, specifying the number of microseconds which have elapsed since the J2000 reference epoch (January 1, 2000, at noon, i.e., 12:00 TT) according to International Atomic Time (aka TAI).

This type is a thin wrapper around u64, and provides convenient interoperability with the hifitime crate.

Use the TryFrom impls to convert between Timestamp and the hifitime::Epoch and hifitime::Duration types. Use the From impls to convert from and to u64 if you need low-level access.

use willow_data_model::prelude::*;

let now = Timestamp::now().expect("The standard library should provide a valid timestamp");
let three_days_later = now + 3.days();
assert!(three_days_later > now);

Implementations

impl Timestamp

pub fn now() -> Result<Self, HifitimeError>

Creates the timestamp corresponding to the current instant in time. WARNING: This assumes that the system time returns the time in UTC. Uses std::time::SystemTime::now under the hood.

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

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Duration> for Timestamp

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign for Timestamp

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<'arbitrary> Arbitrary<'arbitrary> for Timestamp

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsMut<u64> for Timestamp

fn as_mut(&mut self) -> &mut u64

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<u64> for Timestamp

fn as_ref(&self) -> &u64

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a duplicate 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 Default for Timestamp

fn default() -> Timestamp

Returns the “default value” for a type.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl From<Timestamp> for Duration

Creates a duration which corresponds to the number of microsecond represented in the timestamp.

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Epoch

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl From<Timestamp> for u64

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl From<u64> for Timestamp

fn from(value: u64) -> Self

Converts to this type from the input type.

impl GreatestElement for Timestamp

fn greatest() -> Self

Returns the unique greatest element.

fn is_greatest(&self) -> bool

Returns true if and only if self is the greatest element.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LeastElement for Timestamp

fn least() -> Self

Returns the unique least element.

fn is_least(&self) -> bool

Returns true if and only if self is the least element.

impl LowerSemilattice for Timestamp

fn greatest_lower_bound(&self, other: &Self) -> Self

Returns the greatest lower bound of self and other, i.e., the unique greatest element in the type which is less than or equal to both self and other.

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

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 Timestamp

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

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

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Duration> for Timestamp

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign for Timestamp

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<Duration> for Timestamp

Creates a timestamp whose value is the number of microseconds in the duration. Conversion fails if the resulting timestamp would not fit into a u64.

fn try_from(value: Duration) -> Result<Self, Self::Error>

Conversion fails if the resulting timestamp would not fit into a u64.

type Error = <i128 as TryInto<u64>>::Error

The type returned in the event of a conversion error.

impl TryFrom<Epoch> for Timestamp

Conversion fails if the resulting timestamp would not fit into a u64.

fn try_from(value: Epoch) -> Result<Self, Self::Error>

Conversion fails if the resulting timestamp would not fit into a u64.

type Error = <i128 as TryInto<u64>>::Error

The type returned in the event of a conversion error.

impl TryPredecessor for Timestamp

fn try_predecessor(&self) -> Option<Self>

If self has a predecessor, i.e., a unique greatest value which is strictly less than self, returns it. If there is no unique predecessor, returns None.

fn is_predecessor_of(&self, other: &Self) -> bool

Returns true iff self is the predecessor of other.

fn is_not_predecessor_of(&self, other: &Self) -> bool

Returns true iff self is not the predecessor of other.

impl TrySuccessor for Timestamp

fn try_successor(&self) -> Option<Self>

If self has a successor, i.e., a unique least value which is strictly greater than self, returns it. If there is no unique successor, returns None.

fn is_successor_of(&self, other: &Self) -> bool

Returns true iff self is the successor of other.

fn is_not_successor_of(&self, other: &Self) -> bool

Returns true iff self is not the successor of other.

impl UpperSemilattice for Timestamp

fn least_upper_bound(&self, other: &Self) -> Self

Returns the least upper bound of self and other, i.e., the unique least element in the type which is greater than or equal to both self and other.

impl Copy for Timestamp

impl Eq for Timestamp

impl PredecessorExceptForLeast for Timestamp

impl StructuralPartialEq for Timestamp

impl SuccessorExceptForGreatest for Timestamp