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. It implements Default by returning a zero-length Duration.
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);
impl Duration[src]
pub const SECOND: Duration[src]
The duration of one second.
#![feature(duration_constants)] use std::time::Duration; assert_eq!(Duration::SECOND, Duration::from_secs(1));
pub const MILLISECOND: Duration[src]
The duration of one millisecond.
#![feature(duration_constants)] use std::time::Duration; assert_eq!(Duration::MILLISECOND, Duration::from_millis(1));
pub const MICROSECOND: Duration[src]
The duration of one microsecond.
#![feature(duration_constants)] use std::time::Duration; assert_eq!(Duration::MICROSECOND, Duration::from_micros(1));
pub const NANOSECOND: Duration[src]
The duration of one nanosecond.
#![feature(duration_constants)] use std::time::Duration; assert_eq!(Duration::NANOSECOND, Duration::from_nanos(1));
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.
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);
pub fn zero() -> Duration[src]
Creates a new Duration that spans no time.
#![feature(duration_zero)] use std::time::Duration; let duration = Duration::zero(); assert!(duration.is_zero()); assert_eq!(duration.as_nanos(), 0);
pub const fn from_secs(secs: u64) -> Duration[src]
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());
pub const fn from_millis(millis: u64) -> Duration[src]
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());
pub const fn from_micros(micros: u64) -> Duration[src]1.27.0
Creates a new Duration from the specified number of microseconds.
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[src]1.27.0
Creates a new Duration from the specified number of nanoseconds.
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 is_zero(&self) -> bool[src]
Returns true if this Duration spans no time.
#![feature(duration_zero)] use std::time::Duration; assert!(Duration::zero().is_zero()); assert!(Duration::new(0, 0).is_zero()); assert!(Duration::from_nanos(0).is_zero()); assert!(Duration::from_secs(0).is_zero()); assert!(!Duration::new(1, 1).is_zero()); assert!(!Duration::from_nanos(1).is_zero()); assert!(!Duration::from_secs(1).is_zero());
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.
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 const fn subsec_millis(&self) -> u32[src]1.27.0
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).
use std::time::Duration; let duration = Duration::from_millis(5432); assert_eq!(duration.as_secs(), 5); assert_eq!(duration.subsec_millis(), 432);
pub const fn subsec_micros(&self) -> u32[src]1.27.0
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).
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 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).
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 const fn as_millis(&self) -> u128[src]1.33.0
Returns the total number of whole milliseconds contained by this Duration.
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_millis(), 5730);
pub const fn as_micros(&self) -> u128[src]1.33.0
Returns the total number of whole microseconds contained by this Duration.
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_micros(), 5730023);
pub const fn as_nanos(&self) -> u128[src]1.33.0
Returns the total number of nanoseconds contained by this Duration.
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_nanos(), 5730023852);
pub fn checked_add(self, rhs: Duration) -> Option<Duration>[src]1.16.0
Checked Duration addition. Computes self + other, returning None if 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(u64::MAX, 0)), None);
pub fn checked_sub(self, rhs: Duration) -> Option<Duration>[src]1.16.0
Checked Duration subtraction. Computes self - other, returning None if 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);
pub fn checked_mul(self, rhs: u32) -> Option<Duration>[src]1.16.0
Checked Duration multiplication. Computes self * other, returning None 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(u64::MAX - 1, 0).checked_mul(2), None);
pub fn checked_div(self, rhs: u32) -> Option<Duration>[src]1.16.0
Checked Duration division. Computes self / other, returning None if 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);
pub fn as_secs_f64(&self) -> f64[src]1.38.0
Returns the number of seconds contained by this Duration as f64.
The returned value does include the fractional (nanosecond) part of the duration.
use std::time::Duration; let dur = Duration::new(2, 700_000_000); assert_eq!(dur.as_secs_f64(), 2.7);
pub fn as_secs_f32(&self) -> f32[src]1.38.0
Returns the number of seconds contained by this Duration as f32.
The returned value does include the fractional (nanosecond) part of the duration.
use std::time::Duration; let dur = Duration::new(2, 700_000_000); assert_eq!(dur.as_secs_f32(), 2.7);
pub fn from_secs_f64(secs: f64) -> Duration[src]1.38.0
Creates a new Duration from the specified number of seconds represented as f64.
This constructor will panic if secs is not finite, negative or overflows Duration.
use std::time::Duration; let dur = Duration::from_secs_f64(2.7); assert_eq!(dur, Duration::new(2, 700_000_000));
pub fn from_secs_f32(secs: f32) -> Duration[src]1.38.0
Creates a new Duration from the specified number of seconds represented as f32.
This constructor will panic if secs is not finite, negative or overflows Duration.
use std::time::Duration; let dur = Duration::from_secs_f32(2.7); assert_eq!(dur, Duration::new(2, 700_000_000));
pub fn mul_f64(self, rhs: f64) -> Duration[src]1.38.0
Multiplies Duration by f64.
This method will panic if result is not finite, negative or overflows Duration.
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));
pub fn mul_f32(self, rhs: f32) -> Duration[src]1.38.0
Multiplies Duration by f32.
This method will panic if result is not finite, negative or overflows Duration.
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));
pub fn div_f64(self, rhs: f64) -> Duration[src]1.38.0
Divide Duration by f64.
This method will panic if result is not finite, negative or overflows Duration.
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));
pub fn div_f32(self, rhs: f32) -> Duration[src]1.38.0
Divide Duration by f32.
This method will panic if result is not finite, negative or overflows Duration.
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));
pub fn div_duration_f64(self, rhs: Duration) -> f64[src]
Divide Duration by Duration and return f64.
#![feature(div_duration)] 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);
pub fn div_duration_f32(self, rhs: Duration) -> f32[src]
Divide Duration by Duration and return f32.
#![feature(div_duration)] 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);
impl Add<Duration> for Duration[src]
type Output = DurationThe resulting type after applying the + operator.
fn add(self, rhs: Duration) -> Duration[src]
impl Add<Duration> for Instant[src]1.8.0
type Output = InstantThe resulting type after applying the + operator.
fn add(self, other: Duration) -> Instant[src]
This function may panic if the resulting point in time cannot be represented by the underlying data structure. See Instant::checked_add for a version without panic.
impl Add<Duration> for SystemTime[src]1.8.0
type Output = SystemTimeThe resulting type after applying the + operator.
fn add(self, dur: Duration) -> SystemTime[src]
This function may panic if the resulting point in time cannot be represented by the underlying data structure. See SystemTime::checked_add for a version without panic.
impl AddAssign<Duration> for Duration[src]1.9.0
fn add_assign(&mut self, rhs: Duration)[src]
impl AddAssign<Duration> for Instant[src]1.9.0
fn add_assign(&mut self, other: Duration)[src]
impl AddAssign<Duration> for SystemTime[src]1.9.0
fn add_assign(&mut self, other: Duration)[src]
impl Clone for Duration[src]
impl Copy for Duration[src]
impl Debug for Duration[src]1.27.0
impl Default for Duration[src]
impl Div<u32> for Duration[src]
type Output = DurationThe resulting type after applying the / operator.
fn div(self, rhs: u32) -> Duration[src]
impl DivAssign<u32> for Duration[src]1.9.0
fn div_assign(&mut self, rhs: u32)[src]
impl Eq for Duration[src]
impl Hash for Duration[src]
fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [src]
impl Mul<Duration> for u32[src]1.31.0
type Output = DurationThe resulting type after applying the * operator.
fn mul(self, rhs: Duration) -> Duration[src]
impl Mul<u32> for Duration[src]
type Output = DurationThe resulting type after applying the * operator.
fn mul(self, rhs: u32) -> Duration[src]
impl MulAssign<u32> for Duration[src]1.9.0
fn mul_assign(&mut self, rhs: u32)[src]
impl Ord for Duration[src]
fn cmp(&self, other: &Duration) -> Ordering[src]
fn max(self, other: Self) -> Self[src]1.21.0
fn min(self, other: Self) -> Self[src]1.21.0
fn clamp(self, min: Self, max: Self) -> Self[src]
impl PartialEq<Duration> for Duration[src]
impl PartialOrd<Duration> for Duration[src]
fn partial_cmp(&self, other: &Duration) -> Option<Ordering>[src]
fn lt(&self, other: &Duration) -> bool[src]
fn le(&self, other: &Duration) -> bool[src]
fn gt(&self, other: &Duration) -> bool[src]
fn ge(&self, other: &Duration) -> bool[src]
impl StructuralEq for Duration[src]
impl StructuralPartialEq for Duration[src]
impl Sub<Duration> for Duration[src]
type Output = DurationThe resulting type after applying the - operator.
fn sub(self, rhs: Duration) -> Duration[src]
impl Sub<Duration> for Instant[src]1.8.0
type Output = InstantThe resulting type after applying the - operator.
fn sub(self, other: Duration) -> Instant[src]
impl Sub<Duration> for SystemTime[src]1.8.0
type Output = SystemTimeThe resulting type after applying the - operator.
fn sub(self, dur: Duration) -> SystemTime[src]
impl SubAssign<Duration> for Duration[src]1.9.0
fn sub_assign(&mut self, rhs: Duration)[src]
impl SubAssign<Duration> for Instant[src]1.9.0
fn sub_assign(&mut self, other: Duration)[src]
impl SubAssign<Duration> for SystemTime[src]1.9.0
fn sub_assign(&mut self, other: Duration)[src]
impl<'a> Sum<&'a Duration> for Duration[src]1.16.0
impl Sum<Duration> for Duration[src]1.16.0
impl RefUnwindSafe for Durationimpl Send for Durationimpl Sync for Durationimpl Unpin for Durationimpl UnwindSafe for Durationimpl<T> Any for T where
    T: 'static + ?Sized, [src]
impl<T> Borrow<T> for T where
    T: ?Sized, [src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,Â
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,Â
type Item = <I as Iterator>::Item;
impl<R:Â Read + ?Sized, '_> Read for &'_ mut R
impl<W:Â Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,Â
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,Â
type Item = <I as Iterator>::Item;
impl<R:Â Read + ?Sized, '_> Read for &'_ mut R
impl<W:Â Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
    U: From<T>, [src]
impl<T> ToOwned for T where
    T: Clone, [src]
type Owned = TThe resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]
type Error = InfallibleThe type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/time/struct.Duration.html