std::time::Duration - Rust (original) (raw)
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 otherops traits.
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
impl [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
pub fn [new](#method.new)(secs: [u64](../primitive.u64.html), nanos: [u32](../primitive.u32.html)) -> [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
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.
This constructor will panic if the carry from the nanoseconds overflows the seconds counter.
use std::time::Duration;
let five_seconds = Duration::new(5, 0);Run
pub const fn [from_secs](#method.from%5Fsecs)(secs: [u64](../primitive.u64.html)) -> [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
Creates a new Duration from the specified number of whole seconds.
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](#method.from%5Fmillis)(millis: [u64](../primitive.u64.html)) -> [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
Creates a new Duration from the specified number of milliseconds.
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](#method.from%5Fmicros)(micros: [u64](../primitive.u64.html)) -> [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
🔬 This is a nightly-only experimental API. (duration_from_micros #44400)
Creates a new Duration from the specified number of microseconds.
#![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
pub const fn [from_nanos](#method.from%5Fnanos)(nanos: [u64](../primitive.u64.html)) -> [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
🔬 This is a nightly-only experimental API. (duration_extras #46507)
Creates a new Duration from the specified number of nanoseconds.
#![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
pub fn [as_secs](#method.as%5Fsecs)(&self) -> [u64](../primitive.u64.html)
1.3.0
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.
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 fn [subsec_millis](#method.subsec%5Fmillis)(&self) -> [u32](../primitive.u32.html)[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).
#![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
pub fn [subsec_micros](#method.subsec%5Fmicros)(&self) -> [u32](../primitive.u32.html)[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).
#![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
pub fn [subsec_nanos](#method.subsec%5Fnanos)(&self) -> [u32](../primitive.u32.html)
1.3.0
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).
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 fn [checked_add](#method.checked%5Fadd)(self, rhs: [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")) -> [Option](../../std/option/enum.Option.html "enum std::option::Option")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")>
1.16.0
Checked Duration addition. Computes self + other, returning Noneif overflow occurred.
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](#method.checked%5Fsub)(self, rhs: [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")) -> [Option](../../std/option/enum.Option.html "enum std::option::Option")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")>
1.16.0
Checked Duration subtraction. Computes self - other, returning Noneif the result would be negative or if overflow occurred.
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](#method.checked%5Fmul)(self, rhs: [u32](../primitive.u32.html)) -> [Option](../../std/option/enum.Option.html "enum std::option::Option")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")>
1.16.0
Checked Duration multiplication. Computes self * other, returningNone if overflow occurred.
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](#method.checked%5Fdiv)(self, rhs: [u32](../primitive.u32.html)) -> [Option](../../std/option/enum.Option.html "enum std::option::Option")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")>
1.16.0
Checked Duration division. Computes self / other, returning Noneif other == 0.
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
impl [Sub](../../std/ops/trait.Sub.html "trait std::ops::Sub")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
impl [Debug](../../std/fmt/trait.Debug.html "trait std::fmt::Debug") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Mul](../../std/ops/trait.Mul.html "trait std::ops::Mul")<[u32](../primitive.u32.html)> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
impl [Hash](../../std/hash/trait.Hash.html "trait std::hash::Hash") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Default](../../std/default/trait.Default.html "trait std::default::Default") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Clone](../../std/clone/trait.Clone.html "trait std::clone::Clone") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [PartialOrd](../../std/cmp/trait.PartialOrd.html "trait std::cmp::PartialOrd")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Ord](../../std/cmp/trait.Ord.html "trait std::cmp::Ord") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Div](../../std/ops/trait.Div.html "trait std::ops::Div")<[u32](../primitive.u32.html)> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
impl<'a> [Sum](../../std/iter/trait.Sum.html "trait std::iter::Sum")<&'a [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.16.0
impl [Sum](../../std/iter/trait.Sum.html "trait std::iter::Sum")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.16.0
impl [Eq](../../std/cmp/trait.Eq.html "trait std::cmp::Eq") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [PartialEq](../../std/cmp/trait.PartialEq.html "trait std::cmp::PartialEq")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [Add](../../std/ops/trait.Add.html "trait std::ops::Add")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.3.0
impl [Copy](../../std/marker/trait.Copy.html "trait std:📑:Copy") for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")[src]
impl [DivAssign](../../std/ops/trait.DivAssign.html "trait std::ops::DivAssign")<[u32](../primitive.u32.html)> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.9.0
impl [MulAssign](../../std/ops/trait.MulAssign.html "trait std::ops::MulAssign")<[u32](../primitive.u32.html)> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.9.0
impl [SubAssign](../../std/ops/trait.SubAssign.html "trait std::ops::SubAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.9.0
impl [AddAssign](../../std/ops/trait.AddAssign.html "trait std::ops::AddAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Duration](../../std/time/struct.Duration.html "struct std::time::Duration")
1.9.0
impl [Add](../../std/ops/trait.Add.html "trait std::ops::Add")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Instant](../../std/time/struct.Instant.html "struct std::time::Instant")
1.8.0
impl [AddAssign](../../std/ops/trait.AddAssign.html "trait std::ops::AddAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Instant](../../std/time/struct.Instant.html "struct std::time::Instant")
1.9.0
impl [Sub](../../std/ops/trait.Sub.html "trait std::ops::Sub")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Instant](../../std/time/struct.Instant.html "struct std::time::Instant")
1.8.0
impl [SubAssign](../../std/ops/trait.SubAssign.html "trait std::ops::SubAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [Instant](../../std/time/struct.Instant.html "struct std::time::Instant")
1.9.0
impl [Add](../../std/ops/trait.Add.html "trait std::ops::Add")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [SystemTime](../../std/time/struct.SystemTime.html "struct std::time::SystemTime")
1.8.0
impl [AddAssign](../../std/ops/trait.AddAssign.html "trait std::ops::AddAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [SystemTime](../../std/time/struct.SystemTime.html "struct std::time::SystemTime")
1.9.0
impl [Sub](../../std/ops/trait.Sub.html "trait std::ops::Sub")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [SystemTime](../../std/time/struct.SystemTime.html "struct std::time::SystemTime")
1.8.0
impl [SubAssign](../../std/ops/trait.SubAssign.html "trait std::ops::SubAssign")<[Duration](../../std/time/struct.Duration.html "struct std::time::Duration")> for [SystemTime](../../std/time/struct.SystemTime.html "struct std::time::SystemTime")
1.9.0