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.
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 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 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 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!(569000000, duration.subsec_nanos());
pub fn from_micros(micros: u64) -> Duration
[src]
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());
pub 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 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 fn checked_add(self, rhs: Duration) -> Option<Duration>
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(std::u64::MAX, 0)), None);
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 underflow 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>
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(std::u64::MAX - 1, 0).checked_mul(2), None);
pub fn checked_div(self, rhs: u32) -> Option<Duration>
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);
impl Clone for Duration
[src]
fn clone(&self) -> Duration
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Copy for Duration
[src]
impl PartialEq for Duration
[src]
fn eq(&self, __arg_0: &Duration) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Duration) -> bool
[src]
This method tests for !=
.
impl Eq for Duration
[src]
impl PartialOrd for Duration
[src]
fn partial_cmp(&self, __arg_0: &Duration) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Duration) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Duration) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Duration) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Duration) -> bool
[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]
fn cmp(&self, __arg_0: &Duration) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl Debug for Duration
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Hash for Duration
[src]
fn hash<__H:Â Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher,Â
[src]
Feeds a slice of this type into the given [Hasher
]. Read more
impl Default for Duration
[src]
fn default() -> Duration
[src]
Returns the "default value" for a type. Read more
impl Add for Duration
[src]
type Output = Duration
The resulting type after applying the +
operator.
fn add(self, rhs: Duration) -> Duration
[src]
Performs the +
operation.
impl AddAssign for Duration
fn add_assign(&mut self, rhs: Duration)
[src]
Performs the +=
operation.
impl Sub for Duration
[src]
type Output = Duration
The resulting type after applying the -
operator.
fn sub(self, rhs: Duration) -> Duration
[src]
Performs the -
operation.
impl SubAssign for Duration
fn sub_assign(&mut self, rhs: Duration)
[src]
Performs the -=
operation.
impl Mul<u32> for Duration
[src]
type Output = Duration
The resulting type after applying the *
operator.
fn mul(self, rhs: u32) -> Duration
[src]
Performs the *
operation.
impl MulAssign<u32> for Duration
fn mul_assign(&mut self, rhs: u32)
[src]
Performs the *=
operation.
impl Div<u32> for Duration
[src]
type Output = Duration
The resulting type after applying the /
operator.
fn div(self, rhs: u32) -> Duration
[src]
Performs the /
operation.
impl DivAssign<u32> for Duration
fn div_assign(&mut self, rhs: u32)
[src]
Performs the /=
operation.
impl Sum for Duration
fn sum<I:Â Iterator<Item = Duration>>(iter: I) -> Duration
[src]
Method which takes an iterator and generates Self
from the elements by "summing up" the items. Read more
impl<'a> Sum<&'a Duration> for Duration
fn sum<I:Â Iterator<Item = &'a Duration>>(iter: I) -> Duration
[src]
Method which takes an iterator and generates Self
from the elements by "summing up" the items. Read more
impl Add<Duration> for Instant
type Output = Instant
The resulting type after applying the +
operator.
fn add(self, other: Duration) -> Instant
[src]
Performs the +
operation.
impl AddAssign<Duration> for Instant
fn add_assign(&mut self, other: Duration)
[src]
Performs the +=
operation.
impl Sub<Duration> for Instant
type Output = Instant
The resulting type after applying the -
operator.
fn sub(self, other: Duration) -> Instant
[src]
Performs the -
operation.
impl SubAssign<Duration> for Instant
fn sub_assign(&mut self, other: Duration)
[src]
Performs the -=
operation.
impl Add<Duration> for SystemTime
type Output = SystemTime
The resulting type after applying the +
operator.
fn add(self, dur: Duration) -> SystemTime
[src]
Performs the +
operation.
impl AddAssign<Duration> for SystemTime
fn add_assign(&mut self, other: Duration)
[src]
Performs the +=
operation.
impl Sub<Duration> for SystemTime
type Output = SystemTime
The resulting type after applying the -
operator.
fn sub(self, dur: Duration) -> SystemTime
[src]
Performs the -
operation.
impl SubAssign<Duration> for SystemTime
fn sub_assign(&mut self, other: Duration)
[src]
Performs the -=
operation.
© 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