Struct easytime::Duration

pub struct Duration(_);

A Duration type to represent a span of time, typically used for system timeouts.

Each Duration is composed of a whole number of seconds and a fractional part represented in nanoseconds. If the underlying system does not support nanosecond-level precision, APIs binding a system timeout will typically round up the number of nanoseconds.

Durations implement many common traits, including Add, Sub, and other ops traits.

Methods

impl Duration

pub fn new(secs: u64, nanos: u32) -> Duration

Creates a new Duration from the specified number of whole seconds and additional nanoseconds.

If the number of nanoseconds is greater than 1 billion (the number of nanoseconds in a second), then it will carry over into the seconds provided.

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

Creates a new Duration from the specified number of whole seconds.

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

Creates a new Duration from the specified number of milliseconds.

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

Creates a new Duration from the specified number of microseconds.

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

Creates a new Duration from the specified number of nanoseconds.

pub fn as_secs(&self) -> Option<u64>

Returns the number of whole seconds contained by this Duration.

The returned value does not include the fractional (nanosecond) part of the duration, which can be obtained using subsec_nanos.

pub fn subsec_millis(&self) -> Option<u32>

Returns the fractional part of this Duration, in whole milliseconds.

This method does not return the length of the duration when represented by milliseconds. The returned number always represents a fractional portion of a second (i.e., it is less than one thousand).

pub fn subsec_micros(&self) -> Option<u32>

Returns the fractional part of this Duration, in whole microseconds.

This method does not return the length of the duration when represented by microseconds. The returned number always represents a fractional portion of a second (i.e., it is less than one million).

pub fn subsec_nanos(&self) -> Option<u32>

Returns the fractional part of this Duration, in nanoseconds.

This method does not return the length of the duration when represented by nanoseconds. The returned number always represents a fractional portion of a second (i.e., it is less than one billion).

pub fn as_millis(&self) -> Option<u128>

Returns the total number of whole milliseconds contained by this Duration.

pub fn as_micros(&self) -> Option<u128>

Returns the total number of whole microseconds contained by this Duration.

pub fn as_nanos(&self) -> Option<u128>

Returns the total number of nanoseconds contained by this Duration.

impl Duration

pub fn is_some(&self) -> bool

Returns true if into_inner returns Some.

pub fn is_none(&self) -> bool

Returns true if into_inner returns None.

pub const fn into_inner(self) -> Option<Duration>

Returns the contained std::time::Duration or None.

pub fn unwrap_or(self, default: Duration) -> Duration

Returns the contained std::time::Duration or a default.

dur.unwrap_or(default) is equivalent to dur.into_inner().unwrap_or(default).

pub fn unwrap_or_else<F>(self, default: F) -> Duration where
    F: FnOnce() -> Duration, 

Returns the contained std::time::Duration or computes it from a closure.

dur.unwrap_or_else(default) is equivalent to dur.into_inner().unwrap_or_else(default).

Trait Implementations

impl PartialEq<Duration> for Duration

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for Duration

fn default() -> Duration

Returns the "default value" for a type.

impl Ord for Duration

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Duration> for Duration

fn from(dur: Duration) -> Duration

Performs the conversion.

impl Eq for Duration

impl Copy for Duration

impl PartialOrd<Duration> for Duration

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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, 

Feeds a slice of this type into the given [Hasher].

impl Add<Duration> for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, other: Duration) -> Instant

Performs the + operation.

impl Sub<Duration> for Duration

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for Duration

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Duration> for Instant

type Output = Instant

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> Instant

Performs the - operation.

impl Mul<u32> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Duration

Performs the * operation.

impl Mul<Duration> for u32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: Duration) -> Duration

Performs the * operation.

impl Div<u32> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Duration

Performs the / operation.

impl AddAssign<Duration> for Duration

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign<Duration> for Duration

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl SubAssign<Duration> for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign<Duration> for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl MulAssign<u32> for Duration

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl DivAssign<u32> for Duration

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Debug for Duration

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

Formats the value using the given formatter.