Struct Timestamp 

pub struct Timestamp { /* private fields */ }

Structure for holding a raw fog-pack timestamp. This stores a TAI timestamp relative to the Unix epoch of 1970-01-01T00:00:00Z. This is what a correctly configured Linux TIME_TAI clock would return. It also matches the IEEE 1588 Precision Time Protocol standard epoch and timescale.

This is not UTC time, Unix Time, or POSIX Time.

Functions for converting from and to UTC are available as from_utc and utc. The conversion is handled using a built-in table of leap seconds. This table can be updated by calling set_utc_leap_seconds with a new table. See LeapSeconds for how to create a new table.

While these functions do their best to provide correct round-trip conversion for TAI->UTC->TAI and UTC->TAI->UTC, the handling around the exact leap second point can create a delta, due to UTC Unix time reusing a seconds value during the leap second. Using TAI directly if possible is thus preferred, as is sticking to Timestamps as much as possible and only converting back to UTC when you need to display the timestamp for people.

Implementations

impl Timestamp

pub fn from_tai(secs: i64, nanos: u32) -> Option<Timestamp>

Create a TAI timestamp from a raw seconds + nanoseconds value. This should be the number of seconds since the Unix epoch of 1970-01-01T00:00:00Z, without any leap seconds thrown about.

pub fn from_utc(secs: i64, nanos: u32) -> Option<Timestamp>

Create a timestamp from a raw UTC seconds + nanosecond value. This should be the number of seconds since the Unix epoch of 1970-01-01T00:00:00Z, with the usual UTC leap seconds thrown in. This is commonly referred to as Unix time, and is the default timebase for many computer systems.

The UTC-to-TAI conversion is handled using a built-in table of leap seconds. This table can be updated by calling set_utc_leap_seconds with the table.

pub fn from_utc_secs(secs: i64) -> Timestamp

Create a timestamp from a raw UTC seconds value. See from_utc for details.

pub fn from_tai_secs(secs: i64) -> Timestamp

Create a timestamp from a raw TAI seconds value. See from_tai for details.

pub const fn zero() -> Timestamp

Zero time - TAI Unix epoch time

pub const fn min_value() -> Timestamp

Minimum possible time that can be represented

pub const fn max_value() -> Timestamp

Maximum possible time that can be represented

pub fn min(self, other: Timestamp) -> Timestamp

Find the earlier of two timestamps and return it.

pub fn max(self, other: Timestamp) -> Timestamp

Find the later of two timestamps and return it.

pub fn next(self) -> Timestamp

Add 1 nanosecond to timestamp.

pub fn prev(self) -> Timestamp

Subtract 1 nanosecond from timestamp.

pub fn utc(&self) -> (i64, u32)

Return the UNIX timestamp (number of seconds since January 1, 1970 0:00:00 UTC). As a reminder, this is UTC time and thus has leap seconds removed/added.

The TAI-to-UTC conversion is handled using a built-in table of leap seconds. This table can be updated by calling set_utc_leap_seconds with the table.

pub fn tai_secs(&self) -> i64

Return the TAI number of seconds since January 1, 1970 00:00:00 UTC.

pub fn tai_subsec_nanos(&self) -> u32

Returns the number of nanoseconds past the second count.

pub fn time_since(&self, other: &Timestamp) -> TimeDelta

Calculates the time that has elapsed between the other timestamp and this one. Effectively self - other.

pub fn as_vec(&self) -> Vec<u8>

Convert into a byte vector. For extending an existing byte vector, see encode_vec.

pub fn encode_vec(&self, vec: &mut Vec<u8>)

Encode onto a byte vector one of 3 formats:

1. If nanoseconds is nonzero, encode the seconds as little-endian i64, and the nanoseconds as little-endian u32.
2. If nanoseconds is zero & seconds maps to a u32, encode just the seconds as little-endian u32.
3. If nanoseconds is zero & seconds does not map to a u32, encode the seconds as little-endian i64.

The length can be used to determine the format in which it was written.

pub fn size(&self) -> usize

Return the number of bytes needed to encode the timestamp as a byte vector with encode_vec.

pub fn now() -> Timestamp

Create a Timestamp based on the current system time.

Trait Implementations

impl Add<TimeDelta> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, rhs: TimeDelta) -> Timestamp

Performs the + operation.

impl Add<i64> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<TimeDelta> for Timestamp

fn add_assign(&mut self, rhs: TimeDelta)

Performs the += operation.

impl AddAssign<i64> for Timestamp

fn add_assign(&mut self, rhs: i64)

Performs the += operation.

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<'de> Deserialize<'de> for Timestamp

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl From<SystemTime> for Timestamp

fn from(value: SystemTime) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Value

fn from(v: Timestamp) -> Self

Converts to this type from the input type.

impl<'a> From<Timestamp> for ValueRef<'a>

fn from(v: Timestamp) -> Self

Converts to this type from the input type.

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<TimeDelta> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, rhs: TimeDelta) -> Timestamp

Performs the - operation.

impl Sub<i64> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Timestamp

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: Timestamp) -> TimeDelta

Performs the - operation.

impl SubAssign<TimeDelta> for Timestamp

fn sub_assign(&mut self, rhs: TimeDelta)

Performs the -= operation.

impl SubAssign<i64> for Timestamp

fn sub_assign(&mut self, rhs: i64)

Performs the -= operation.

impl TryFrom<&[u8]> for Timestamp

Parse an encoded timestamp. Must be 4, 8, or 12 bytes (matching what was written by Timestamp::encode_vec)

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Timestamp

type Error = Value

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ValueRef<'a>> for Timestamp

type Error = ValueRef<'a>

The type returned in the event of a conversion error.

fn try_from(v: ValueRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp