Struct std::time::Duration1.24.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.

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]

1.3.0
[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

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

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

[src]

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

[src]

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

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

[src]

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

[src]

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

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

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

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

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

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

Trait Implementations

impl Sub<Duration> for Duration
1.3.0
[src]

The resulting type after applying the - operator.

[src]

Performs the - operation.

impl Debug for Duration
[src]

[src]

Formats the value using the given formatter. Read more

impl Mul<u32> for Duration
1.3.0
[src]

The resulting type after applying the * operator.

[src]

Performs the * operation.

impl Hash for Duration
[src]

[src]

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

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

impl Default for Duration
[src]

[src]

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

impl Clone for Duration
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl PartialOrd<Duration> for Duration
[src]

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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]

[src]

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

1.21.0
[src]

Compares and returns the maximum of two values. Read more

1.21.0
[src]

Compares and returns the minimum of two values. Read more

impl Div<u32> for Duration
1.3.0
[src]

The resulting type after applying the / operator.

[src]

Performs the / operation.

impl<'a> Sum<&'a Duration> for Duration
1.16.0
[src]

[src]

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

impl Sum<Duration> for Duration
1.16.0
[src]

[src]

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

impl Eq for Duration
[src]

impl PartialEq<Duration> for Duration
[src]

[src]

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

[src]

This method tests for !=.

impl Add<Duration> for Duration
1.3.0
[src]

The resulting type after applying the + operator.

[src]

Performs the + operation.

impl Copy for Duration
[src]

impl DivAssign<u32> for Duration
1.9.0
[src]

[src]

Performs the /= operation.

impl MulAssign<u32> for Duration
1.9.0
[src]

[src]

Performs the *= operation.

impl SubAssign<Duration> for Duration
1.9.0
[src]

[src]

Performs the -= operation.

impl AddAssign<Duration> for Duration
1.9.0
[src]

[src]

Performs the += operation.

impl Add<Duration> for Instant
1.8.0
[src]

The resulting type after applying the + operator.

[src]

Performs the + operation.

impl AddAssign<Duration> for Instant
1.9.0
[src]

[src]

Performs the += operation.

impl Sub<Duration> for Instant
1.8.0
[src]

The resulting type after applying the - operator.

[src]

Performs the - operation.

impl SubAssign<Duration> for Instant
1.9.0
[src]

[src]

Performs the -= operation.

impl Add<Duration> for SystemTime
1.8.0
[src]

The resulting type after applying the + operator.

[src]

Performs the + operation.

impl AddAssign<Duration> for SystemTime
1.9.0
[src]

[src]

Performs the += operation.

impl Sub<Duration> for SystemTime
1.8.0
[src]

The resulting type after applying the - operator.

[src]

Performs the - operation.

impl SubAssign<Duration> for SystemTime
1.9.0
[src]

[src]

Performs the -= operation.