Struct Duration 

pub struct Duration { /* private fields */ }

A relative amount of time, in milliseconds.

A duration is at most Duration::MAX, about 12.4 days. Constructors and arithmetic saturate at it. This keeps every timer the stack sets well within the range where an Instant compares correctly.

Implementations

impl Duration

pub const ZERO: Duration

A duration of zero time.

pub const MAX: Duration

The longest duration: 2³⁰ ms, about 12.4 days.

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

Create a new Duration from a number of milliseconds.

Saturates at Duration::MAX.

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

Create a new Duration from a number of seconds.

Saturates at Duration::MAX.

pub fn from_secs_f64(secs: f64) -> Duration

Create a new Duration from a number of seconds, as an f64.

The fraction below one millisecond is truncated. Saturates at Duration::MAX.

Panics

Panics if secs is negative or NaN.

pub fn from_secs_f32(secs: f32) -> Duration

Create a new Duration from a number of seconds, as an f32.

The fraction below one millisecond is truncated. Saturates at Duration::MAX.

Panics

Panics if secs is negative or NaN.

pub const fn is_zero(&self) -> bool

Whether this is Duration::ZERO.

pub const fn as_secs(&self) -> u32

The number of whole seconds in this Duration.

pub const fn as_millis(&self) -> u32

The number of milliseconds in this Duration.

pub const fn subsec_millis(&self) -> u32

The number of milliseconds past as_secs.

Always less than 1000.

pub fn as_secs_f64(&self) -> f64

This Duration as a number of seconds, as an f64.

pub fn as_secs_f32(&self) -> f32

This Duration as a number of seconds, as an f32.

pub const fn checked_add(&self, rhs: Duration) -> Option<Duration>

self + rhs, or None if it is longer than Duration::MAX.

pub const fn checked_sub(&self, rhs: Duration) -> Option<Duration>

self - rhs, or None if rhs is longer than self.

pub const fn checked_mul(&self, rhs: u32) -> Option<Duration>

self * rhs, or None if it is longer than Duration::MAX.

pub const fn checked_div(&self, rhs: u32) -> Option<Duration>

self / rhs, or None if rhs is zero.

pub const fn div_ceil(&self, rhs: u32) -> Duration

self / rhs, rounded up to the next millisecond.

Panics if rhs is zero.

pub const fn saturating_add(&self, rhs: Duration) -> Duration

self + rhs, saturating at Duration::MAX.

pub const fn saturating_sub(&self, rhs: Duration) -> Duration

self - rhs, saturating at Duration::ZERO.

pub const fn saturating_mul(&self, rhs: u32) -> Duration

self * rhs, saturating at Duration::MAX.

pub const fn abs_diff(&self, other: Duration) -> Duration

The absolute difference between self and other.

pub fn mul_f64(&self, rhs: f64) -> Duration

self multiplied by rhs.

Saturates at Duration::MAX.

Panics

Panics if the result is negative or NaN.

pub fn mul_f32(&self, rhs: f32) -> Duration

self multiplied by rhs.

Saturates at Duration::MAX.

Panics

Panics if the result is negative or NaN.

pub fn div_f64(&self, rhs: f64) -> Duration

self divided by rhs.

Saturates at Duration::MAX.

Panics

Panics if the result is negative or NaN.

pub fn div_f32(&self, rhs: f32) -> Duration

self divided by rhs.

Saturates at Duration::MAX.

Panics

Panics if the result is negative or NaN.

pub fn div_duration_f64(&self, rhs: Duration) -> f64

The ratio of self to rhs.

pub fn div_duration_f32(&self, rhs: Duration) -> f32

The ratio of self to rhs.

Trait Implementations

impl Add for Duration

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

Saturates at Duration::MAX.

type Output = Duration

The resulting type after applying the + operator.

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Duration

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Clone for Duration

fn clone(&self) -> Duration

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() -> Duration

Returns the “default value” for a type.

impl Display for Duration

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

Formats the value using the given formatter.

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 DivAssign<u32> for Duration

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Eq for Duration

impl From<Duration> for Duration

fn from(other: Duration) -> Duration

Truncates below one millisecond, and saturates at Duration::MAX.

impl From<Duration> for Duration

fn from(val: Duration) -> Self

Converts to this type from the input type.

impl Mul<Duration> for u32

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

Saturates at Duration::MAX.

type Output = Duration

The resulting type after applying the * operator.

impl Mul<u32> for Duration

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

Saturates at Duration::MAX.

type Output = Duration

The resulting type after applying the * operator.

impl MulAssign<u32> for Duration

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

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

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.

impl PartialEq for Duration

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd 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: &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

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, rhs: Duration) -> Instant

Performs the - operation.

impl SubAssign for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.