Struct std::time::Duration

[+] Show type declaration

pub struct Duration { /* fields omitted */ }

[−] Expand description

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

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.

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

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

[−]

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

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

[−]

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

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

[−]

🔬 This is a nightly-only experimental API. (duration_from_micros #44400)

Creates a new Duration from the specified number of microseconds.

Examples

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

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

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

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

[−]

🔬 This is a nightly-only experimental API. (duration_extras #46507)

Creates a new Duration from the specified number of nanoseconds.

Examples

#![feature(duration_extras)]
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());

pub fn as_secs(&self) -> 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.

Examples

use std::time::Duration;

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

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

pub fn subsec_millis(&self) -> u32

[−]

🔬 This is a nightly-only experimental API. (duration_extras #46507)

Returns the fractional part of this Duration, in 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

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

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

pub fn subsec_micros(&self) -> u32

[−]

🔬 This is a nightly-only experimental API. (duration_extras #46507)

Returns the fractional part of this Duration, in 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

#![feature(duration_extras, duration_from_micros)]
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);

pub fn subsec_nanos(&self) -> 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).

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

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

[−]

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

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

[−]

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

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

[−]

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

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

[−]

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

Trait Implementations

impl Copy for Duration

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 Debug for Duration

[+]

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

[−]

Formats the value using the given formatter.

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 Sum<Duration> for Duration

[+]

fn sum<I>(iter: I) -> Duration where     I: Iterator<Item = Duration>,

[−]

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<'a> Sum<&'a Duration> for Duration

[+]

fn sum<I>(iter: I) -> Duration where     I: Iterator<Item = &'a Duration>,

[−]

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl DivAssign<u32> for Duration

[+]

fn div_assign(&mut self, rhs: u32)

[−]

Performs the /= operation.

impl SubAssign<Duration> for Duration

[+]

fn sub_assign(&mut self, rhs: Duration)

[−]

Performs the -= operation.

impl Ord for Duration

[+]

fn cmp(&self, __arg_0: &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 Hash for Duration

[+]

fn hash<__H>(&self, __arg_0: &mut __H) where     __H: Hasher,

[−]

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 PartialEq<Duration> for Duration

[+]

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

[−]

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

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

[−]

This method tests for !=.

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

[+]

fn mul_assign(&mut self, rhs: u32)

[−]

Performs the *= operation.

impl AddAssign<Duration> for Duration

[+]

fn add_assign(&mut self, rhs: Duration)

[−]

Performs the += operation.

impl Default for Duration

[+]

fn default() -> Duration

[−]

Returns the "default value" for a type.

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 PartialOrd<Duration> for Duration

[+]

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

[−]

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

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

[−]

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

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

[−]

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

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

[−]

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

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

[−]

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

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 Eq for Duration

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 AddAssign<Duration> for Instant

[+]

fn add_assign(&mut self, other: 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 SubAssign<Duration> for Instant

[+]

fn sub_assign(&mut self, other: Duration)

[−]

Performs the -= operation.

impl Add<Duration> for SystemTime

[+]

type Output = SystemTime

The resulting type after applying the + operator.

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

[−]

Performs the + operation.

impl AddAssign<Duration> for SystemTime

[+]

fn add_assign(&mut self, other: Duration)

[−]

Performs the += operation.

impl Sub<Duration> for SystemTime

[+]

type Output = SystemTime

The resulting type after applying the - operator.

fn sub(self, dur: Duration) -> SystemTime

[−]

Performs the - operation.

impl SubAssign<Duration> for SystemTime

[+]

fn sub_assign(&mut self, other: Duration)

[−]

Performs the -= operation.