Struct Timestamp 

pub struct Timestamp { /* private fields */ }

A timestamp value that can be serialized to and deserialized from JSON.

Timestamp is stored internally as (seconds: i64, nanos: u32), where seconds counts (signed) seconds since the Unix epoch and nanos is always in [0, 1_000_000_000). This matches the google.protobuf.Timestamp convention and lets the type be no_std-compatible. Negative whole-second values combined with a positive nanos mean the same instant as the float seconds + nanos / 1e9, e.g. (-5, 200_000_000) is -4.8s.

Invariants

Every Timestamp value satisfies:

• seconds is in SECONDS_MIN..=SECONDS_MAX, i.e. it represents an instant between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z inclusive.
• nanos is in [0, 1_000_000_000).

All public constructors enforce these invariants — Timestamp::now, Timestamp::from_unix, Timestamp::from_str, From<SystemTime>, and the optional From<chrono::DateTime<Tz>> either validate, saturate, or are infallible by construction. As a result, Buffer::format and fmt::Display never fail.

With the default std feature, this type round-trips to and from std::time::SystemTime efficiently — the conversion is just a duration_since(UNIX_EPOCH) followed by storing the two fields (saturating at the supported range bounds).

Creating timestamps

// From Unix seconds + nanoseconds.
let ts = Timestamp::from_unix(1_641_006_000, 0).unwrap();

// Equivalent via the `TryFrom<(i64, u32)>` impl.
let ts = Timestamp::try_from((1_641_006_000i64, 0u32)).unwrap();

// With the `std` feature: from current system time.
let now = Timestamp::now();
let ts = Timestamp::from(std::time::SystemTime::now());

Inspecting timestamps

let ts = Timestamp::from_unix(1_641_006_000, 250_000_000).unwrap();
assert_eq!(ts.seconds(), 1_641_006_000);
assert_eq!(ts.subsec_nanos(), 250_000_000);

Implementations

impl Timestamp

pub fn from_unix(seconds: i64, nanos: u32) -> Result<Self, TimestampError>

Constructs a Timestamp from Unix seconds and nanoseconds.

Returns TimestampError::OutOfRange if seconds is outside the representable year 1..=9999 range, or if nanos >= 1_000_000_000.

Examples

let ts = Timestamp::from_unix(0, 0).unwrap();
assert_eq!(ts.seconds(), 0);
assert_eq!(ts.subsec_nanos(), 0);

pub fn seconds(&self) -> i64

Returns the (signed) seconds component, counted from the Unix epoch.

pub fn subsec_nanos(&self) -> u32

Returns the fractional-second component, in nanoseconds.

The returned value is always in [0, 1_000_000_000). The naming matches std::time::Duration::subsec_nanos.

pub fn now() -> Self

Returns a Timestamp representing the current system time.

This is a convenience method for Timestamp::from(SystemTime::now()).

Trait Implementations

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

Available on crate feature serde only.

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

Available on crate feature std only.

Wraps a SystemTime reference as a Timestamp. See From<SystemTime> for the saturation contract.

fn from(value: &SystemTime) -> Self

Converts to this type from the input type.

impl From<&Timestamp> for Timestamp

fn from(value: &Timestamp) -> Self

Converts to this type from the input type.

impl From<SystemTime> for Timestamp

Available on crate feature std only.

Converts a SystemTime into a Timestamp by computing its offset from the Unix epoch.

SystemTime can in principle represent instants outside the Timestamp range (year 1 through year 9999); such values are saturated to the nearest in-range second. In practice this only affects deliberately constructed SystemTimes; wall-clock times from the system clock are well within range.

fn from(value: SystemTime) -> Self

Converts to this type from the input type.

impl From<Timestamp> for SystemTime

Available on crate feature std only.

Converts a Timestamp back into a SystemTime by adding (or subtracting) its offset from the Unix epoch.

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl FromStr for Timestamp

type Err = TimestampError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(i64, u32)> for Timestamp

type Error = TimestampError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp