Struct std::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 number of seconds and nanosecond precision. APIs binding a system timeout will typically round up the nanosecond precision if the underlying system does not support that level of precision.

Durations implement many common traits, including Add, Sub, and other ops traits. Currently a duration may only be inspected for its number of seconds and its nanosecond precision.

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]

Creates a new Duration from the specified number of seconds and additional nanosecond precision.

If the 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.

Creates a new Duration from the specified number of seconds.

Creates a new Duration from the specified number of milliseconds.

Returns the number of whole seconds represented by this duration.

The extra precision represented by this duration is ignored (i.e. extra nanoseconds are not represented in the returned value).

Returns the nanosecond precision represented by this duration.

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

Unstable (duration_checked_ops #35774)

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

Examples

Basic usage:

#![feature(duration_checked_ops)]

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

Unstable (duration_checked_ops #35774)

Checked duration subtraction. Computes self + other, returning None if the result would be negative or if underflow occurred.

Examples

Basic usage:

#![feature(duration_checked_ops)]

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

Unstable (duration_checked_ops #35774)

Checked duration multiplication. Computes self * other, returning None if underflow or overflow occurred.

Examples

Basic usage:

#![feature(duration_checked_ops)]

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

Unstable (duration_checked_ops #35774)

Checked duration division. Computes self / other, returning None if other == 0 or the operation results in underflow or overflow.

Examples

Basic usage:

#![feature(duration_checked_ops)]

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

Trait Implementations

impl Clone for Duration
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Copy for Duration
[src]

impl PartialEq for Duration
[src]

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

This method tests for !=.

impl Eq for Duration
[src]

impl PartialOrd for Duration
[src]

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

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

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

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

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

impl Ord for Duration
[src]

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

impl Debug for Duration
[src]

Formats the value using the given formatter.

impl Hash for Duration
[src]

Feeds this value into the state given, updating the hasher as necessary.

Feeds a slice of this type into the state provided.

impl Default for Duration
[src]

Returns the "default value" for a type. Read more

impl Add for Duration
[src]

The resulting type after applying the + operator

The method for the + operator

impl AddAssign for Duration
1.9.0
[src]

The method for the += operator

impl Sub for Duration
[src]

The resulting type after applying the - operator

The method for the - operator

impl SubAssign for Duration
1.9.0
[src]

The method for the -= operator

impl Mul<u32> for Duration
[src]

The resulting type after applying the * operator

The method for the * operator

impl MulAssign<u32> for Duration
1.9.0
[src]

The method for the *= operator

impl Div<u32> for Duration
[src]

The resulting type after applying the / operator

The method for the / operator

impl DivAssign<u32> for Duration
1.9.0
[src]

The method for the /= operator