Struct Duration 

pub struct Duration(/* private fields */);

A length of time, in nanoseconds on a u64: at most about 584 years.

+ and - saturate at Duration::MAX and at zero. The default is Duration::ZERO.

The try_from_* constructors return None where the others saturate: the try_ prefix on an Option, as chrono’s TimeDelta::try_seconds has it.

Implementations

impl Duration

pub const fn saturating_from_core(duration: Duration) -> Self

duration, clamped at Duration::MAX, about 584 years: for a host mapping its own clock onto the timeline, where a time that far out means never. A length that must fit, from configuration say, goes through Duration::try_from instead, which refuses one too long.

impl Duration

pub const ZERO: Self

No time.

pub const MAX: Self

The longest representable duration, u64::MAX nanoseconds: about 584 years.

pub const fn from_nanos(nanos: u64) -> Self

nanos nanoseconds.

pub const fn from_micros(micros: u64) -> Self

micros microseconds, saturating at Duration::MAX.

pub const fn from_millis(millis: u64) -> Self

millis milliseconds, saturating at Duration::MAX.

pub const fn from_secs(secs: u64) -> Self

secs seconds, saturating at Duration::MAX.

pub const fn try_from_micros(micros: u64) -> Option<Self>

micros microseconds, or None past Duration::MAX.

pub const fn try_from_millis(millis: u64) -> Option<Self>

millis milliseconds, or None past Duration::MAX.

pub const fn try_from_secs(secs: u64) -> Option<Self>

secs seconds, or None past Duration::MAX.

pub const fn as_nanos(self) -> u64

The length in nanoseconds.

pub const fn is_zero(self) -> bool

Whether the length is zero.

pub const fn as_micros(self) -> u64

The whole microseconds in the length, rounded toward zero.

pub const fn as_millis(self) -> u64

The whole milliseconds in the length, rounded toward zero.

pub const fn as_secs(self) -> u64

The whole seconds in the length, rounded toward zero.

pub const fn checked_add(self, other: Self) -> Option<Self>

self + other, or None past Duration::MAX.

pub const fn saturating_add(self, other: Self) -> Self

self + other, clamped at Duration::MAX.

pub const fn checked_sub(self, other: Self) -> Option<Self>

self - other, or None below zero.

pub const fn saturating_sub(self, other: Self) -> Self

self - other, clamped at zero.

pub const fn checked_mul(self, factor: u32) -> Option<Self>

self times factor, or None past Duration::MAX.

pub const fn saturating_mul(self, factor: u32) -> Self

self times factor, clamped at Duration::MAX.

pub const fn min(self, other: Self) -> Self

The shorter of self and other: Ord::min for a const context.

pub const fn max(self, other: Self) -> Self

The longer of self and other: Ord::max for a const context.

pub const fn checked_rem(self, divisor: Self) -> Option<Self>

What is left of self after taking out as many whole divisors as fit, or None for a zero divisor: the offset into a repeating cycle, say.

It takes one step per bit of the quotient, without a 64-bit division routine (see the crate docs).

Trait Implementations

impl Add for Duration

fn add(self, rhs: Self) -> Self

Saturating, as Duration::saturating_add.

type Output = Duration

The resulting type after applying the + operator.

impl Add<Duration> for Instant

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

Saturating, as Instant::saturating_add.

type Output = Instant

The resulting type after applying the + operator.

impl AddAssign for Duration

fn add_assign(&mut self, rhs: Self)

Saturating, as Duration::saturating_add.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Saturating, as Instant::saturating_add.

impl Clone for Duration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Duration

impl Debug for Duration

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

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Duration

impl From<Duration> for Duration

fn from(duration: Duration) -> Self

The same length, exactly. Splitting it into seconds and nanoseconds takes no 64-bit division routine (see the crate docs).

impl Hash for Duration

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 Duration

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

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.

impl PartialEq for Duration

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Duration

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

impl Sub for Duration

fn sub(self, rhs: Self) -> Self

Saturating, as Duration::saturating_sub.

type Output = Duration

The resulting type after applying the - operator.

impl Sub<Duration> for Instant

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

Saturating, as Instant::saturating_sub.

type Output = Instant

The resulting type after applying the - operator.

impl SubAssign for Duration

fn sub_assign(&mut self, rhs: Self)

Saturating, as Duration::saturating_sub.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Saturating, as Instant::saturating_sub.

impl TryFrom<Duration> for Duration

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

The same length, or DurationTooLong for one past Duration::MAX: a core::time::Duration reaches about 584 billion years.

type Error = DurationTooLong

The type returned in the event of a conversion error.