1.3.0[][src]Struct std::time::Duration

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.

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

Methods

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 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) -> Duration[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) -> Duration[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[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[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 as_secs(&self) -> u64[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[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[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) -> u32[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[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[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[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(std::u64::MAX, 0)), None);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 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(std::u64::MAX - 1, 0).checked_mul(2), None);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) -> f64[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

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

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

Examples

#![feature(duration_float)]
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) -> f32[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

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

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

Examples

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

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

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

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

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

Multiplies Duration by f64.

Panics

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

Examples

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

Multiplies Duration by f32.

Panics

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

Examples

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

Divide Duration by f64.

Panics

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

Examples

#![feature(duration_float)]
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) -> Duration[src]

🔬 This is a nightly-only experimental API. (duration_float #54361)

Divide Duration by f32.

Panics

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

Examples

#![feature(duration_float)]
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. (duration_float #54361)

Divide Duration by Duration and return f64.

Examples

#![feature(duration_float)]
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. (duration_float #54361)

Divide Duration by Duration and return f32.

Examples

#![feature(duration_float)]
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 AddAssign<Duration> for Duration1.9.0[src]

impl Div<u32> for Duration[src]

type Output = Duration

The resulting type after applying the / operator.

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

type Output = Duration

The resulting type after applying the * operator.

impl Mul<u32> for Duration[src]

type Output = Duration

The resulting type after applying the * operator.

impl Hash for Duration[src]

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

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

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

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

impl PartialOrd<Duration> for Duration[src]

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

impl Default for Duration[src]

impl Sub<Duration> for Duration[src]

type Output = Duration

The resulting type after applying the - operator.

impl Eq for Duration[src]

impl Clone for Duration[src]

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]

impl Add<Duration> for Duration[src]

type Output = Duration

The resulting type after applying the + operator.

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

impl Copy for Duration[src]

impl Ord for Duration[src]

fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

fn clamp(self, min: Self, max: Self) -> Self[src]

🔬 This is a nightly-only experimental API. (clamp #44095)

Restrict a value to a certain interval. Read more

impl PartialEq<Duration> for Duration[src]

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

impl Add<Duration> for Instant1.8.0[src]

type Output = Instant

The resulting type after applying the + operator.

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

Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See checked_add for a version without panic.

impl Add<Duration> for SystemTime1.8.0[src]

type Output = SystemTime

The resulting type after applying the + operator.

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

Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See checked_add for a version without panic.

impl Sub<Duration> for Instant1.8.0[src]

type Output = Instant

The resulting type after applying the - operator.

impl Sub<Duration> for SystemTime1.8.0[src]

type Output = SystemTime

The resulting type after applying the - operator.

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

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

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

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

Auto Trait Implementations

impl Send for Duration

impl Sync for Duration

Blanket Implementations

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

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.

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

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.

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

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

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.