Struct core::time::Duration1.3.0[][src]

pub struct Duration { /* fields omitted */ }

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. It implements Default by returning a zero-length Duration.

Examples

use std::time::Duration;

let five_seconds = Duration::new(5, 0);
let five_seconds_and_five_nanos = five_seconds + Duration::new(0, 5);

assert_eq!(five_seconds_and_five_nanos.as_secs(), 5);
assert_eq!(five_seconds_and_five_nanos.subsec_nanos(), 5);

let ten_millis = Duration::from_millis(10);
Run

Formatting Duration values

Duration intentionally does not have a Display impl, as there are a variety of ways to format spans of time for human readability. Duration provides a Debug impl that shows the full precision of the value.

The Debug output uses the non-ASCII “µs” suffix for microseconds. If your program output may appear in contexts that cannot rely on full Unicode compatibility, you may wish to format Duration objects yourself or use a crate to do so.

Implementations

impl Duration[src]

pub const SECOND: Duration[src]

🔬 This is a nightly-only experimental API. (duration_constants #57391)

The duration of one second.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::SECOND, Duration::from_secs(1));
Run

pub const MILLISECOND: Duration[src]

🔬 This is a nightly-only experimental API. (duration_constants #57391)

The duration of one millisecond.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::MILLISECOND, Duration::from_millis(1));
Run

pub const MICROSECOND: Duration[src]

🔬 This is a nightly-only experimental API. (duration_constants #57391)

The duration of one microsecond.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::MICROSECOND, Duration::from_micros(1));
Run

pub const NANOSECOND: Duration[src]

🔬 This is a nightly-only experimental API. (duration_constants #57391)

The duration of one nanosecond.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::NANOSECOND, Duration::from_nanos(1));
Run

pub const ZERO: Duration1.53.0[src]

A duration of zero time.

Examples

use std::time::Duration;

let duration = Duration::ZERO;
assert!(duration.is_zero());
assert_eq!(duration.as_nanos(), 0);
Run

pub const MAX: Duration1.53.0[src]

The maximum duration.

May vary by platform as necessary. Must be able to contain the difference between two instances of Instant or two instances of SystemTime. This constraint gives it a value of about 584,942,417,355 years in practice, which is currently used on all platforms.

Examples

use std::time::Duration;

assert_eq!(Duration::MAX, Duration::new(u64::MAX, 1_000_000_000 - 1));
Run

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

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.

Panics

This constructor will panic if the carry from the nanoseconds overflows the seconds counter.

Examples

use std::time::Duration;

let five_seconds = Duration::new(5, 0);
Run

pub const fn from_secs(secs: u64) -> Duration1.3.0 (const: 1.32.0)[src]

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

Examples

use std::time::Duration;

let duration = Duration::from_secs(5);

assert_eq!(5, duration.as_secs());
assert_eq!(0, duration.subsec_nanos());
Run

pub const fn from_millis(millis: u64) -> Duration1.3.0 (const: 1.32.0)[src]

Creates a new Duration from the specified number of milliseconds.

Examples

use std::time::Duration;

let duration = Duration::from_millis(2569);

assert_eq!(2, duration.as_secs());
assert_eq!(569_000_000, duration.subsec_nanos());
Run

pub const fn from_micros(micros: u64) -> Duration1.27.0 (const: 1.32.0)[src]

Creates a new Duration from the specified number of microseconds.

Examples

use std::time::Duration;

let duration = Duration::from_micros(1_000_002);

assert_eq!(1, duration.as_secs());
assert_eq!(2000, duration.subsec_nanos());
Run

pub const fn from_nanos(nanos: u64) -> Duration1.27.0 (const: 1.32.0)[src]

Creates a new Duration from the specified number of nanoseconds.

Examples

use std::time::Duration;

let duration = Duration::from_nanos(1_000_000_123);

assert_eq!(1, duration.as_secs());
assert_eq!(123, duration.subsec_nanos());
Run

pub const fn is_zero(&self) -> bool1.53.0 (const: 1.53.0)[src]

Returns true if this Duration spans no time.

Examples

use std::time::Duration;

assert!(Duration::ZERO.is_zero());
assert!(Duration::new(0, 0).is_zero());
assert!(Duration::from_nanos(0).is_zero());
assert!(Duration::from_secs(0).is_zero());

assert!(!Duration::new(1, 1).is_zero());
assert!(!Duration::from_nanos(1).is_zero());
assert!(!Duration::from_secs(1).is_zero());
Run

pub const fn as_secs(&self) -> u641.3.0 (const: 1.32.0)[src]

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.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730023852);
assert_eq!(duration.as_secs(), 5);
Run

To determine the total number of seconds represented by the Duration, use as_secs in combination with subsec_nanos:

use std::time::Duration;

let duration = Duration::new(5, 730023852);

assert_eq!(5.730023852,
           duration.as_secs() as f64
           + duration.subsec_nanos() as f64 * 1e-9);
Run

pub const fn subsec_millis(&self) -> u321.27.0 (const: 1.32.0)[src]

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).

Examples

use std::time::Duration;

let duration = Duration::from_millis(5432);
assert_eq!(duration.as_secs(), 5);
assert_eq!(duration.subsec_millis(), 432);
Run

pub const fn subsec_micros(&self) -> u321.27.0 (const: 1.32.0)[src]

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).

Examples

use std::time::Duration;

let duration = Duration::from_micros(1_234_567);
assert_eq!(duration.as_secs(), 1);
assert_eq!(duration.subsec_micros(), 234_567);
Run

pub const fn subsec_nanos(&self) -> u321.3.0 (const: 1.32.0)[src]

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).

Examples

use std::time::Duration;

let duration = Duration::from_millis(5010);
assert_eq!(duration.as_secs(), 5);
assert_eq!(duration.subsec_nanos(), 10_000_000);
Run

pub const fn as_millis(&self) -> u1281.33.0 (const: 1.33.0)[src]

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

Examples

use std::time::Duration;

let duration = Duration::new(5, 730023852);
assert_eq!(duration.as_millis(), 5730);
Run

pub const fn as_micros(&self) -> u1281.33.0 (const: 1.33.0)[src]

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

Examples

use std::time::Duration;

let duration = Duration::new(5, 730023852);
assert_eq!(duration.as_micros(), 5730023);
Run

pub const fn as_nanos(&self) -> u1281.33.0 (const: 1.33.0)[src]

Returns the total number of nanoseconds contained by this Duration.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730023852);
assert_eq!(duration.as_nanos(), 5730023852);
Run

pub fn checked_add(self, rhs: Duration) -> Option<Duration>1.16.0[src]

Checked Duration addition. Computes self + other, returning None if overflow occurred.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
assert_eq!(Duration::new(1, 0).checked_add(Duration::new(u64::MAX, 0)), None);
Run

pub fn saturating_add(self, rhs: Duration) -> Duration1.53.0[src]

Saturating Duration addition. Computes self + other, returning Duration::MAX if overflow occurred.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::new(0, 0).saturating_add(Duration::new(0, 1)), Duration::new(0, 1));
assert_eq!(Duration::new(1, 0).saturating_add(Duration::new(u64::MAX, 0)), Duration::MAX);
Run

pub fn checked_sub(self, rhs: Duration) -> Option<Duration>1.16.0[src]

Checked Duration subtraction. Computes self - other, returning None if the result would be negative or if overflow occurred.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);
Run

pub fn saturating_sub(self, rhs: Duration) -> Duration1.53.0[src]

Saturating Duration subtraction. Computes self - other, returning Duration::ZERO if the result would be negative or if overflow occurred.

Examples

use std::time::Duration;

assert_eq!(Duration::new(0, 1).saturating_sub(Duration::new(0, 0)), Duration::new(0, 1));
assert_eq!(Duration::new(0, 0).saturating_sub(Duration::new(0, 1)), Duration::ZERO);
Run

pub fn checked_mul(self, rhs: u32) -> Option<Duration>1.16.0[src]

Checked Duration multiplication. Computes self * other, returning None if overflow occurred.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
assert_eq!(Duration::new(u64::MAX - 1, 0).checked_mul(2), None);
Run

pub fn saturating_mul(self, rhs: u32) -> Duration1.53.0[src]

Saturating Duration multiplication. Computes self * other, returning Duration::MAX if overflow occurred.

Examples

#![feature(duration_constants)]
use std::time::Duration;

assert_eq!(Duration::new(0, 500_000_001).saturating_mul(2), Duration::new(1, 2));
assert_eq!(Duration::new(u64::MAX - 1, 0).saturating_mul(2), Duration::MAX);
Run

pub fn checked_div(self, rhs: u32) -> Option<Duration>1.16.0[src]

Checked Duration division. Computes self / other, returning None if other == 0.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
assert_eq!(Duration::new(2, 0).checked_div(0), None);
Run

pub fn as_secs_f64(&self) -> f641.38.0[src]

Returns the number of seconds contained by this Duration as f64.

The returned value does include the fractional (nanosecond) part of the duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
assert_eq!(dur.as_secs_f64(), 2.7);
Run

pub fn as_secs_f32(&self) -> f321.38.0[src]

Returns the number of seconds contained by this Duration as f32.

The returned value does include the fractional (nanosecond) part of the duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
assert_eq!(dur.as_secs_f32(), 2.7);
Run

pub fn from_secs_f64(secs: f64) -> Duration1.38.0[src]

Creates a new Duration from the specified number of seconds represented as f64.

Panics

This constructor will panic if secs is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::from_secs_f64(2.7);
assert_eq!(dur, Duration::new(2, 700_000_000));
Run

pub fn from_secs_f32(secs: f32) -> Duration1.38.0[src]

Creates a new Duration from the specified number of seconds represented as f32.

Panics

This constructor will panic if secs is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::from_secs_f32(2.7);
assert_eq!(dur, Duration::new(2, 700_000_000));
Run

pub fn mul_f64(self, rhs: f64) -> Duration1.38.0[src]

Multiplies Duration by f64.

Panics

This method will panic if result is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
assert_eq!(dur.mul_f64(3.14), Duration::new(8, 478_000_000));
assert_eq!(dur.mul_f64(3.14e5), Duration::new(847_800, 0));
Run

pub fn mul_f32(self, rhs: f32) -> Duration1.38.0[src]

Multiplies Duration by f32.

Panics

This method will panic if result is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
// note that due to rounding errors result is slightly different
// from 8.478 and 847800.0
assert_eq!(dur.mul_f32(3.14), Duration::new(8, 478_000_640));
assert_eq!(dur.mul_f32(3.14e5), Duration::new(847799, 969_120_256));
Run

pub fn div_f64(self, rhs: f64) -> Duration1.38.0[src]

Divide Duration by f64.

Panics

This method will panic if result is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
assert_eq!(dur.div_f64(3.14), Duration::new(0, 859_872_611));
// note that truncation is used, not rounding
assert_eq!(dur.div_f64(3.14e5), Duration::new(0, 8_598));
Run

pub fn div_f32(self, rhs: f32) -> Duration1.38.0[src]

Divide Duration by f32.

Panics

This method will panic if result is not finite, negative or overflows Duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
// note that due to rounding errors result is slightly
// different from 0.859_872_611
assert_eq!(dur.div_f32(3.14), Duration::new(0, 859_872_576));
// note that truncation is used, not rounding
assert_eq!(dur.div_f32(3.14e5), Duration::new(0, 8_598));
Run

pub fn div_duration_f64(self, rhs: Duration) -> f64[src]

🔬 This is a nightly-only experimental API. (div_duration #63139)

Divide Duration by Duration and return f64.

Examples

#![feature(div_duration)]
use std::time::Duration;

let dur1 = Duration::new(2, 700_000_000);
let dur2 = Duration::new(5, 400_000_000);
assert_eq!(dur1.div_duration_f64(dur2), 0.5);
Run

pub fn div_duration_f32(self, rhs: Duration) -> f32[src]

🔬 This is a nightly-only experimental API. (div_duration #63139)

Divide Duration by Duration and return f32.

Examples

#![feature(div_duration)]
use std::time::Duration;

let dur1 = Duration::new(2, 700_000_000);
let dur2 = Duration::new(5, 400_000_000);
assert_eq!(dur1.div_duration_f32(dur2), 0.5);
Run

Trait Implementations

impl Add<Duration> for Duration[src]

type Output = Duration

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Duration[src]

Performs the + operation. Read more

impl AddAssign<Duration> for Duration1.9.0[src]

fn add_assign(&mut self, rhs: Duration)[src]

Performs the += operation. Read more

impl Clone for Duration[src]

fn clone(&self) -> Duration[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Duration1.27.0[src]

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

Formats the value using the given formatter. Read more

impl Default for Duration[src]

fn default() -> Duration[src]

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

impl Div<u32> for Duration[src]

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl DivAssign<u32> for Duration1.9.0[src]

fn div_assign(&mut self, rhs: u32)[src]

Performs the /= operation. Read more

impl Hash for Duration[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where
    Self: Sized
[src]

Feeds a slice of this type into the given Hasher. Read more

impl Mul<Duration> for u321.31.0[src]

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: Duration) -> Duration[src]

Performs the * operation. Read more

impl Mul<u32> for Duration[src]

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl MulAssign<u32> for Duration1.9.0[src]

fn mul_assign(&mut self, rhs: u32)[src]

Performs the *= operation. Read more

impl Ord for Duration[src]

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

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self where
    Self: Sized
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self where
    Self: Sized
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self where
    Self: Sized
1.50.0[src]

Restrict a value to a certain interval. Read more

impl PartialEq<Duration> for Duration[src]

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

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

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

This method tests for !=.

impl PartialOrd<Duration> for Duration[src]

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

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl Sub<Duration> for Duration[src]

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Duration[src]

Performs the - operation. Read more

impl SubAssign<Duration> for Duration1.9.0[src]

fn sub_assign(&mut self, rhs: Duration)[src]

Performs the -= operation. Read more

impl<'a> Sum<&'a Duration> for Duration1.16.0[src]

fn sum<I: Iterator<Item = &'a Duration>>(iter: I) -> Duration[src]

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

impl Sum<Duration> for Duration1.16.0[src]

fn sum<I: Iterator<Item = Duration>>(iter: I) -> Duration[src]

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

impl Copy for Duration[src]

impl Eq for Duration[src]

impl StructuralEq for Duration[src]

impl StructuralPartialEq for Duration[src]

Auto Trait Implementations

impl Send for Duration

impl Sync for Duration

impl Unpin for Duration

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&Self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&Self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut Self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(Self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.