Skip to main content

Timestamp

Struct Timestamp 

Source
pub struct Timestamp(/* private fields */);
Expand description

A whole-second Unix timestamp used for access time and expiration.

Also used for object creation times. Values range from the Unix epoch through 9999-12-31T23:59:59Z. When constructed with fractional seconds, the timestamp rounds up to the next whole second. Values outside this range are rejected.

Serializes in the same format as SystemTime, with secs_since_epoch and nanos_since_epoch fields. The nanoseconds field is always zero when serialized. Deserialization accepts legacy fractional timestamps and rounds them upward.

use std::time::Duration;
use objectstore_types::time::Timestamp;

let deadline = Timestamp::from_unix_micros(1_700_000_000_123_456)?;
assert_eq!(deadline.as_rfc3339().to_string(), "2023-11-14T22:13:21Z");
let extended = deadline + Duration::from_secs(60);
assert_eq!(extended.as_secs(), deadline.as_secs() + 60);

Implementations§

Source§

impl Timestamp

Source

pub const UNIX_EPOCH: Self

The Unix epoch.

Source

pub fn now() -> Self

Captures the current wall-clock time, rounded up to a whole second.

§Panics

Panics if the system clock is outside the supported timestamp range.

Source

pub fn from_unix_secs(seconds: u64) -> Result<Self, InvalidTimestamp>

Constructs a timestamp from whole Unix seconds.

Source

pub fn from_unix_micros(micros: i64) -> Result<Self, InvalidTimestamp>

Constructs a timestamp from Unix microseconds, rounding fractional seconds upward.

Source

pub fn from_rfc3339(value: &str) -> Result<Self, TimestampError>

Parses an RFC3339 timestamp, rounding fractional seconds upward.

Returns an error if the input is invalid or outside the supported timestamp range.

Source

pub fn as_secs(self) -> u64

Returns the timestamp in whole Unix seconds.

Source

pub fn as_micros(self) -> u64

Returns the second-aligned timestamp in Unix microseconds.

Source

pub fn as_rfc3339(self) -> Rfc3339Timestamp

Returns a copy that displays and serializes as an RFC3339 string.

Source

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

Adds a duration, rounding upward, or returns None if the result is out of range.

Source

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

Subtracts a duration, rounding upward, or returns None if the result precedes the epoch.

Source

pub fn checked_duration_since(self, earlier: Self) -> Option<Duration>

Returns the elapsed duration, or None if earlier is later than this timestamp.

Trait Implementations§

Source§

impl Add<Duration> for Timestamp

Source§

fn add(self, duration: Duration) -> Self

Adds a duration, rounding up. Panics if the result is outside the supported range.

Source§

type Output = Timestamp

The resulting type after applying the + operator.
Source§

impl Clone for Timestamp

Source§

fn clone(&self) -> Timestamp

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Timestamp

Source§

impl Debug for Timestamp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Timestamp

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Timestamp

Source§

impl From<Timestamp> for SystemTime

Source§

fn from(time: Timestamp) -> Self

Converts to this type from the input type.
Source§

impl Hash for Timestamp

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Timestamp

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Timestamp

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Timestamp

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Timestamp

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Timestamp

Source§

impl Sub<Duration> for Timestamp

Source§

fn sub(self, duration: Duration) -> Self

Subtracts a duration, rounding up. Panics if the result precedes the epoch.

Source§

type Output = Timestamp

The resulting type after applying the - operator.
Source§

impl TryFrom<SystemTime> for Timestamp

Source§

type Error = InvalidTimestamp

The type returned in the event of a conversion error.
Source§

fn try_from(time: SystemTime) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.