Struct fog_pack::types::Timestamp

pub struct Timestamp { /* fields omitted */ }

Structure for holding a raw fog-pack timestamp. This stores time in some consistent internal format, which may or may not be UTC. UTC time can always be extracted from it.

Implementations

impl Timestamp

pub fn from_utc(sec: i64, nano: u32) -> Option<Timestamp>

Create a timestamp from a raw seconds + nanoseconds value

pub fn from_sec(sec: i64) -> Timestamp

pub const fn zero() -> Timestamp

Zero time - UTC 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

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

pub fn next(self) -> Timestamp

Add 1 nanosecond to timestamp. Will go into leap second (nanoseconds > 1e6) before it goes to the next second.

pub fn prev(self) -> Timestamp

Subtract 1 nanosecond from timestamp. Will go into leap second (nanoseconds > 1e6) when it must decrement a second.

pub fn timestamp_utc(&self) -> i64

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

pub fn timestamp_subsec_nanos(&self) -> u32

Returns the number of nanoseconds past the second count.

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 standard byte, the seconds as little-endian i64, and the nanoseconds as little-endian u32.
2. If nanoseconds is zero & seconds maps to a u32, encode the standard byte, and the seconds as little-endian u32.
3. If nanoseconds is zero & seconds does not map to a u32, encode the standard byte, and the seconds as little-endian i64.

pub fn size(&self) -> usize

pub fn now() -> Option<Timestamp>

Create a Timestamp based on the current system time. Can fail if the system clock is extremely wrong - the time is before Unix Epoch, or nanosecond portion is greater than 2 seconds.

Trait Implementations

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

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Timestamp

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

impl From<Timestamp> for Value

fn from(v: Timestamp) -> Self

Performs the conversion.

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

fn from(v: Timestamp) -> Self

Performs the conversion.

impl Hash for Timestamp

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

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.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub 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.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 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 StructuralEq for Timestamp

impl StructuralPartialEq for Timestamp

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 TryFrom<&'_ [u8]> for Timestamp

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.