Skip to main content

Instant

Struct Instant 

Source
pub struct Instant { /* private fields */ }
Expand description

A SOML instant: a point in time with nanosecond precision, from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.

This is a UTC timestamp, not a monotonic clock like std::time::Instant, so it is meant to be used qualified, as soml::Instant.

The offset a document writes an instant with is not part of the value, so 2026-09-19T21:00:00+07:00 and 2026-09-19T14:00:00Z are the same instant. Display writes the canonical form, which is always UTC.

let instant: soml::Instant = "2026-09-19T21:00:00.5+07:00".parse()?;

assert_eq!(instant.to_string(), "2026-09-19T14:00:00.5Z");
assert_eq!(instant.unix_seconds(), 1_789_826_400);
assert_eq!(instant.nanoseconds(), 500_000_000);

With serde, it reads only from a SOML instant, not from a string, and it is written as a SOML instant. Other formats, such as JSON, see its canonical text.

Implementations§

Source§

impl Instant

Source

pub const MIN: Self

The earliest instant, 0001-01-01T00:00:00Z.

Source

pub const MAX: Self

The latest instant, 9999-12-31T23:59:59.999999999Z.

Source

pub const fn from_unix(seconds: i64, nanoseconds: u32) -> Option<Self>

Creates an instant from whole seconds since 1970-01-01T00:00:00Z, and nanoseconds after them.

Returns None when nanoseconds is one billion or more, or when the instant is outside the years 0001 to 9999.

let instant = soml::Instant::from_unix(0, 0).unwrap();
assert_eq!(instant.to_string(), "1970-01-01T00:00:00Z");

assert!(soml::Instant::from_unix(-62_135_596_801, 0).is_none());
Source

pub const fn from_unix_nanoseconds(nanoseconds: i128) -> Option<Self>

Creates an instant from nanoseconds since 1970-01-01T00:00:00Z. Returns None when the instant is outside the years 0001 to 9999.

let instant = soml::Instant::from_unix_nanoseconds(1_500_000_000).unwrap();
assert_eq!(instant.to_string(), "1970-01-01T00:00:01.5Z");
Source

pub const fn unix_nanoseconds(self) -> i128

Nanoseconds since 1970-01-01T00:00:00Z. Negative for an instant before 1970.

Source

pub const fn unix_seconds(self) -> i64

Whole seconds since 1970-01-01T00:00:00Z. Negative for an instant before 1970, which is then made later by nanoseconds().

Source

pub const fn nanoseconds(self) -> u32

The nanoseconds after unix_seconds(), from 0 to 999,999,999.

Trait Implementations§

Source§

impl Clone for Instant

Source§

fn clone(&self) -> Self

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 Instant

Source§

impl Debug for Instant

Source§

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

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

impl<'de> Deserialize<'de> for Instant

Source§

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

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

impl Display for Instant

Writes the canonical form: UTC with Z, and a fraction without trailing zeros, left out when it is zero.

Source§

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

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

impl Eq for Instant

Source§

impl From<Instant> for DateTime<Utc>

Source§

fn from(instant: Instant) -> Self

Converts to this type from the input type.
Source§

impl From<Instant> for Value

Source§

fn from(value: Instant) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Instant

Reads an instant in SOML syntax, with any offset.

let instant: soml::Instant = "2026-09-19T14:00:00Z".parse()?;
assert_eq!(instant.unix_seconds(), 1_789_826_400);

assert!("2026-09-19".parse::<soml::Instant>().is_err());
Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(text: &str) -> Result<Self, Error>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Instant

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 Instant

Source§

fn cmp(&self, other: &Self) -> 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§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Instant

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Instant

Source§

fn partial_cmp(&self, other: &Self) -> 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 Instant

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 Instant

Source§

impl TryFrom<DateTime<Utc>> for Instant

Source§

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

Fails when the time is outside the years 0001 to 9999, or is a leap second.

Source§

type Error = Error

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

impl TryFrom<Instant> for SystemTime

Source§

fn try_from(instant: Instant) -> Result<Self, Error>

Fails when the platform’s SystemTime cannot hold the instant. On Windows, for example, it cannot go before the year 1601.

Source§

type Error = Error

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

impl TryFrom<Instant> for Timestamp

Source§

fn try_from(instant: Instant) -> Result<Self, Error>

Fails for an instant after 9999-12-30T22:00:00.999999999Z, where jiff’s range ends.

Source§

type Error = Error

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

impl TryFrom<SystemTime> for Instant

Source§

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

Fails when the time is outside the years 0001 to 9999.

Source§

type Error = Error

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

impl TryFrom<Timestamp> for Instant

Source§

fn try_from(timestamp: Timestamp) -> Result<Self, Error>

Fails when the timestamp is outside the years 0001 to 9999.

Source§

type Error = Error

The type returned in the event of a conversion error.

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.