Skip to main content

Duration

Struct Duration 

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

A SOML duration: a signed length of time, as a whole number of nanoseconds in the i64 range, which is about 292 years either way.

Unlike std::time::Duration, it can be negative, so it is meant to be used qualified, as soml::Duration.

Display writes the canonical form, in hours, minutes, and seconds with a fraction:

let duration: soml::Duration = "90m".parse()?;
assert_eq!(duration.to_string(), "1h30m");

let duration = soml::Duration::from_nanoseconds(-1_500_000_000);
assert_eq!(duration.to_string(), "-1.5s");

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

Implementations§

Source§

impl Duration

Source

pub const MIN: Self

The most negative duration, -9223372036854775808ns.

Source

pub const MAX: Self

The longest duration, 9223372036854775807ns.

Source

pub const ZERO: Self

The zero duration, 0s.

Source

pub const fn from_nanoseconds(nanoseconds: i64) -> Self

Creates a duration from a signed count of nanoseconds.

Source

pub const fn nanoseconds(self) -> i64

The signed count of nanoseconds.

Source

pub const fn is_negative(self) -> bool

Whether the duration is less than zero.

Trait Implementations§

Source§

impl Clone for Duration

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 Duration

Source§

impl Debug for Duration

Source§

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

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

impl Default for Duration

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Duration

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 Duration

Writes the canonical form: - when negative, then the hours, minutes, and seconds, each left out when zero, with the seconds’ fraction written like an instant’s. Zero is 0s.

Source§

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

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

impl Eq for Duration

Source§

impl From<Duration> for TimeDelta

Source§

fn from(duration: Duration) -> Self

Converts to this type from the input type.
Source§

impl From<Duration> for SignedDuration

Source§

fn from(duration: Duration) -> Self

Converts to this type from the input type.
Source§

impl From<Duration> for Value

Source§

fn from(value: Duration) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Duration

Reads a duration in SOML syntax.

let duration: soml::Duration = "1.5s".parse()?;
assert_eq!(duration.nanoseconds(), 1_500_000_000);

assert!("1d".parse::<soml::Duration>().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 Duration

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 Duration

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 Duration

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 Duration

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 Duration

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 Duration

Source§

impl TryFrom<Duration> for Duration

Source§

fn try_from(duration: StdDuration) -> Result<Self, Error>

Fails when the duration is longer than i64::MAX nanoseconds, about 292 years.

Source§

type Error = Error

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

impl TryFrom<Duration> for Duration

Source§

fn try_from(duration: Duration) -> Result<Self, Error>

Fails when the duration is negative, because a std::time::Duration cannot be.

Source§

type Error = Error

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

impl TryFrom<SignedDuration> for Duration

Source§

fn try_from(duration: SignedDuration) -> Result<Self, Error>

Fails when the duration is longer than i64::MAX nanoseconds, about 292 years either way.

Source§

type Error = Error

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

impl TryFrom<TimeDelta> for Duration

Source§

fn try_from(delta: TimeDelta) -> Result<Self, Error>

Fails when the duration is longer than i64::MAX nanoseconds, about 292 years either way.

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.