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.
Duration
s 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.
pub const MILLISECOND: Duration
[src]
The duration of one millisecond.
pub const MICROSECOND: Duration
[src]
The duration of one microsecond.
pub const NANOSECOND: Duration
[src]
The duration of one nanosecond.
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.
pub fn zero() -> Duration
[src]
Creates a new Duration
that spans no time.
pub const fn from_secs(secs: u64) -> Duration
[src]
Creates a new Duration
from the specified number of whole seconds.
pub const fn from_millis(millis: u64) -> Duration
[src]
Creates a new Duration
from the specified number of milliseconds.
pub const fn from_micros(micros: u64) -> Duration
[src]1.27.0
Creates a new Duration
from the specified number of microseconds.
pub const fn from_nanos(nanos: u64) -> Duration
[src]1.27.0
Creates a new Duration
from the specified number of nanoseconds.
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
:
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).
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).
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).
pub const fn as_millis(&self) -> u128
[src]1.33.0
Returns the total number of whole milliseconds contained by this Duration
.
pub const fn as_micros(&self) -> u128
[src]1.33.0
Returns the total number of whole microseconds contained by this Duration
.
pub const fn as_nanos(&self) -> u128
[src]1.33.0
Returns the total number of nanoseconds contained by this Duration
.
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:
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:
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:
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:
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.
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.
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
.
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
.
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
.
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
.
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
.
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
.
pub fn div_duration_f32(self, rhs: Duration) -> f32
[src]
Divide Duration
by Duration
and return f32
.
impl Add<Duration> for Duration
[src]
type Output = Duration
The resulting type after applying the +
operator.
fn add(self, rhs: Duration) -> Duration
[src]
impl Add<Duration> for Instant
[src]1.8.0
type Output = Instant
The 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 = SystemTime
The 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 = Duration
The 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 = Duration
The resulting type after applying the *
operator.
fn mul(self, rhs: Duration) -> Duration
[src]
impl Mul<u32> for Duration
[src]
type Output = Duration
The 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 = Duration
The resulting type after applying the -
operator.
fn sub(self, rhs: Duration) -> Duration
[src]
impl Sub<Duration> for Instant
[src]1.8.0
type Output = Instant
The resulting type after applying the -
operator.
fn sub(self, other: Duration) -> Instant
[src]
impl Sub<Duration> for SystemTime
[src]1.8.0
type Output = SystemTime
The 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 Duration
impl Send for Duration
impl Sync for Duration
impl Unpin for Duration
impl UnwindSafe for Duration
impl<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 = T
The 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 = Infallible
The 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