1.3.0[−][src]Struct std::time::Duration
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]
impl Durationpub fn new(secs: u64, nanos: u32) -> Duration[src]
pub fn new(secs: u64, nanos: u32) -> DurationCreates 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
pub const fn from_secs(secs: u64) -> Duration[src]
pub const fn from_secs(secs: u64) -> DurationCreates 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
pub const fn from_millis(millis: u64) -> Duration[src]
pub const fn from_millis(millis: u64) -> DurationCreates 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
pub const fn from_micros(micros: u64) -> Duration1.27.0[src]
pub const fn from_micros(micros: u64) -> DurationCreates a new Duration from the specified number of microseconds.
Examples
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(nanos: u64) -> Duration1.27.0[src]
pub const fn from_nanos(nanos: u64) -> DurationCreates a new Duration from the specified number of nanoseconds.
Examples
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 const fn as_secs(&self) -> u64[src]
pub const fn as_secs(&self) -> u64Returns 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
pub const fn subsec_millis(&self) -> u321.27.0[src]
pub const fn subsec_millis(&self) -> u32Returns 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).
Examples
use std::time::Duration; let duration = Duration::from_millis(5432); assert_eq!(duration.as_secs(), 5); assert_eq!(duration.subsec_millis(), 432);Run
pub const fn subsec_micros(&self) -> u321.27.0[src]
pub const fn subsec_micros(&self) -> u32Returns 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).
Examples
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 const fn subsec_nanos(&self) -> u32[src]
pub const fn subsec_nanos(&self) -> u32Returns 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
pub const fn as_millis(&self) -> u128[src]
pub const fn as_millis(&self) -> u128Returns the total number of whole milliseconds contained by this Duration.
Examples
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_millis(), 5730);Run
pub const fn as_micros(&self) -> u128[src]
pub const fn as_micros(&self) -> u128Returns the total number of whole microseconds contained by this Duration.
Examples
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_micros(), 5730023);Run
pub const fn as_nanos(&self) -> u128[src]
pub const fn as_nanos(&self) -> u128Returns the total number of nanoseconds contained by this Duration.
Examples
use std::time::Duration; let duration = Duration::new(5, 730023852); assert_eq!(duration.as_nanos(), 5730023852);Run
pub fn checked_add(self, rhs: Duration) -> Option<Duration>1.16.0[src]
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);Run
pub fn checked_sub(self, rhs: Duration) -> Option<Duration>1.16.0[src]
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);Run
pub fn checked_mul(self, rhs: u32) -> Option<Duration>1.16.0[src]
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);Run
pub fn checked_div(self, rhs: u32) -> Option<Duration>1.16.0[src]
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);Run
pub const fn as_float_secs(&self) -> f64[src]
pub const fn as_float_secs(&self) -> f64Returns the number of seconds contained by this Duration as f64.
The returned value does include the fractional (nanosecond) part of the duration.
Examples
#![feature(duration_float)] use std::time::Duration; let dur = Duration::new(2, 700_000_000); assert_eq!(dur.as_float_secs(), 2.7);Run
pub fn from_float_secs(secs: f64) -> Duration[src]
pub fn from_float_secs(secs: f64) -> DurationCreates a new Duration from the specified number of seconds.
Panics
This constructor will panic if secs is not finite, negative or overflows Duration.
Examples
#![feature(duration_float)] use std::time::Duration; let dur = Duration::from_float_secs(2.7); assert_eq!(dur, Duration::new(2, 700_000_000));Run
pub fn mul_f64(self, rhs: f64) -> Duration[src]
pub fn mul_f64(self, rhs: f64) -> DurationMultiply Duration by f64.
Panics
This method will panic if result is not finite, negative or overflows Duration.
Examples
#![feature(duration_float)] 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));Run
pub fn div_f64(self, rhs: f64) -> Duration[src]
pub fn div_f64(self, rhs: f64) -> DurationDivide Duration by f64.
Panics
This method will panic if result is not finite, negative or overflows Duration.
Examples
#![feature(duration_float)] 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));Run
pub fn div_duration(self, rhs: Duration) -> f64[src]
pub fn div_duration(self, rhs: Duration) -> f64Trait Implementations
impl Copy for Duration[src]
impl Copy for Durationimpl MulAssign<u32> for Duration1.9.0[src]
impl MulAssign<u32> for Durationfn mul_assign(&mut self, rhs: u32)[src]
fn mul_assign(&mut self, rhs: u32)impl Sub<Duration> for Duration[src]
impl Sub<Duration> for Durationtype Output = Duration
The resulting type after applying the - operator.
fn sub(self, rhs: Duration) -> Duration[src]
fn sub(self, rhs: Duration) -> Durationimpl Hash for Duration[src]
impl Hash for Durationfn hash<__H>(&self, state: &mut __H) where
__H: Hasher, [src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher, fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, [src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, Feeds a slice of this type into the given [Hasher]. Read more
impl<'a> Sum<&'a Duration> for Duration1.16.0[src]
impl<'a> Sum<&'a Duration> for Durationimpl Sum<Duration> for Duration1.16.0[src]
impl Sum<Duration> for Durationimpl SubAssign<Duration> for Duration1.9.0[src]
impl SubAssign<Duration> for Durationfn sub_assign(&mut self, rhs: Duration)[src]
fn sub_assign(&mut self, rhs: Duration)impl Eq for Duration[src]
impl Eq for Durationimpl Div<u32> for Duration[src]
impl Div<u32> for Durationtype Output = Duration
The resulting type after applying the / operator.
fn div(self, rhs: u32) -> Duration[src]
fn div(self, rhs: u32) -> Durationimpl Clone for Duration[src]
impl Clone for Durationfn clone(&self) -> Duration[src]
fn clone(&self) -> Durationfn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Debug for Duration1.27.0[src]
impl Debug for Durationimpl Default for Duration[src]
impl Default for Durationimpl AddAssign<Duration> for Duration1.9.0[src]
impl AddAssign<Duration> for Durationfn add_assign(&mut self, rhs: Duration)[src]
fn add_assign(&mut self, rhs: Duration)impl DivAssign<u32> for Duration1.9.0[src]
impl DivAssign<u32> for Durationfn div_assign(&mut self, rhs: u32)[src]
fn div_assign(&mut self, rhs: u32)impl PartialEq<Duration> for Duration[src]
impl PartialEq<Duration> for Durationimpl Add<Duration> for Duration[src]
impl Add<Duration> for Durationtype Output = Duration
The resulting type after applying the + operator.
fn add(self, rhs: Duration) -> Duration[src]
fn add(self, rhs: Duration) -> Durationimpl Ord for Duration[src]
impl Ord for Durationfn cmp(&self, other: &Duration) -> Ordering[src]
fn cmp(&self, other: &Duration) -> Orderingfn max(self, other: Self) -> Self1.21.0[src]
fn max(self, other: Self) -> SelfCompares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self1.21.0[src]
fn min(self, other: Self) -> SelfCompares and returns the minimum of two values. Read more
impl PartialOrd<Duration> for Duration[src]
impl PartialOrd<Duration> for Durationfn partial_cmp(&self, other: &Duration) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &Duration) -> Option<Ordering>fn lt(&self, other: &Duration) -> bool[src]
fn lt(&self, other: &Duration) -> boolfn le(&self, other: &Duration) -> bool[src]
fn le(&self, other: &Duration) -> boolfn gt(&self, other: &Duration) -> bool[src]
fn gt(&self, other: &Duration) -> boolfn ge(&self, other: &Duration) -> bool[src]
fn ge(&self, other: &Duration) -> boolimpl Mul<u32> for Duration[src]
impl Mul<u32> for Durationtype Output = Duration
The resulting type after applying the * operator.
fn mul(self, rhs: u32) -> Duration[src]
fn mul(self, rhs: u32) -> Durationimpl Mul<Duration> for u321.31.0[src]
impl Mul<Duration> for u32type Output = Duration
The resulting type after applying the * operator.
fn mul(self, rhs: Duration) -> Duration[src]
fn mul(self, rhs: Duration) -> Durationimpl Sub<Duration> for Instant1.8.0[src]
impl Sub<Duration> for Instanttype Output = Instant
The resulting type after applying the - operator.
fn sub(self, other: Duration) -> Instant[src]
fn sub(self, other: Duration) -> Instantimpl Sub<Duration> for SystemTime1.8.0[src]
impl Sub<Duration> for SystemTimetype Output = SystemTime
The resulting type after applying the - operator.
fn sub(self, dur: Duration) -> SystemTime[src]
fn sub(self, dur: Duration) -> SystemTimeimpl Add<Duration> for Instant1.8.0[src]
impl Add<Duration> for Instanttype Output = Instant
The resulting type after applying the + operator.
fn add(self, other: Duration) -> Instant[src]
fn add(self, other: Duration) -> Instantimpl Add<Duration> for SystemTime1.8.0[src]
impl Add<Duration> for SystemTimetype Output = SystemTime
The resulting type after applying the + operator.
fn add(self, dur: Duration) -> SystemTime[src]
fn add(self, dur: Duration) -> SystemTimeimpl AddAssign<Duration> for Instant1.9.0[src]
impl AddAssign<Duration> for Instantfn add_assign(&mut self, other: Duration)[src]
fn add_assign(&mut self, other: Duration)impl AddAssign<Duration> for SystemTime1.9.0[src]
impl AddAssign<Duration> for SystemTimefn add_assign(&mut self, other: Duration)[src]
fn add_assign(&mut self, other: Duration)impl SubAssign<Duration> for Instant1.9.0[src]
impl SubAssign<Duration> for Instantfn sub_assign(&mut self, other: Duration)[src]
fn sub_assign(&mut self, other: Duration)impl SubAssign<Duration> for SystemTime1.9.0[src]
impl SubAssign<Duration> for SystemTimefn sub_assign(&mut self, other: Duration)[src]
fn sub_assign(&mut self, other: Duration)Auto Trait Implementations
Blanket Implementations
impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, ⓘImportant traits for &'_ mut Ifn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut Timpl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeIdimpl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone,