Struct time::Duration [−][src]
pub struct Duration { /* fields omitted */ }
A span of time with nanosecond precision.
Each Duration
is composed of a whole number of seconds and a fractional part represented in
nanoseconds.
This implementation allows for negative durations, unlike core::time::Duration
.
Implementations
impl Duration
[src]
pub const ZERO: Self
[src]
Equivalent to 0.seconds()
.
assert_eq!(Duration::ZERO, 0.seconds());Run
pub const NANOSECOND: Self
[src]
Equivalent to 1.nanoseconds()
.
assert_eq!(Duration::NANOSECOND, 1.nanoseconds());Run
pub const MICROSECOND: Self
[src]
Equivalent to 1.microseconds()
.
assert_eq!(Duration::MICROSECOND, 1.microseconds());Run
pub const MILLISECOND: Self
[src]
Equivalent to 1.milliseconds()
.
assert_eq!(Duration::MILLISECOND, 1.milliseconds());Run
pub const SECOND: Self
[src]
Equivalent to 1.seconds()
.
assert_eq!(Duration::SECOND, 1.seconds());Run
pub const MINUTE: Self
[src]
Equivalent to 1.minutes()
.
assert_eq!(Duration::MINUTE, 1.minutes());Run
pub const HOUR: Self
[src]
Equivalent to 1.hours()
.
assert_eq!(Duration::HOUR, 1.hours());Run
pub const DAY: Self
[src]
Equivalent to 1.days()
.
assert_eq!(Duration::DAY, 1.days());Run
pub const WEEK: Self
[src]
Equivalent to 1.weeks()
.
assert_eq!(Duration::WEEK, 1.weeks());Run
pub const MIN: Self
[src]
The minimum possible duration. Adding any negative duration to this will cause an overflow.
pub const MAX: Self
[src]
The maximum possible duration. Adding any positive duration to this will cause an overflow.
pub const fn is_zero(self) -> bool
[src]
Check if a duration is exactly zero.
assert!(0.seconds().is_zero()); assert!(!1.nanoseconds().is_zero());Run
pub const fn is_negative(self) -> bool
[src]
Check if a duration is negative.
assert!((-1).seconds().is_negative()); assert!(!0.seconds().is_negative()); assert!(!1.seconds().is_negative());Run
pub const fn is_positive(self) -> bool
[src]
Check if a duration is positive.
assert!(1.seconds().is_positive()); assert!(!0.seconds().is_positive()); assert!(!(-1).seconds().is_positive());Run
pub const fn abs(self) -> Self
[src]
Get the absolute value of the duration.
This method saturates the returned value if it would otherwise overflow.
assert_eq!(1.seconds().abs(), 1.seconds()); assert_eq!(0.seconds().abs(), 0.seconds()); assert_eq!((-1).seconds().abs(), 1.seconds());Run
This feature is const fn
when using rustc >= 1.47.
pub const fn new(seconds: i64, nanoseconds: i32) -> Self
[src]
Create a new Duration
with the provided seconds and nanoseconds. If nanoseconds is at
least ±109, it will wrap to the number of seconds.
assert_eq!(Duration::new(1, 0), 1.seconds()); assert_eq!(Duration::new(-1, 0), (-1).seconds()); assert_eq!(Duration::new(1, 2_000_000_000), 3.seconds());Run
pub const fn weeks(weeks: i64) -> Self
[src]
Create a new Duration
with the given number of weeks. Equivalent to
Duration::seconds(weeks * 604_800)
.
assert_eq!(Duration::weeks(1), 604_800.seconds());Run
pub const fn days(days: i64) -> Self
[src]
Create a new Duration
with the given number of days. Equivalent to
Duration::seconds(days * 86_400)
.
assert_eq!(Duration::days(1), 86_400.seconds());Run
pub const fn hours(hours: i64) -> Self
[src]
Create a new Duration
with the given number of hours. Equivalent to
Duration::seconds(hours * 3_600)
.
assert_eq!(Duration::hours(1), 3_600.seconds());Run
pub const fn minutes(minutes: i64) -> Self
[src]
Create a new Duration
with the given number of minutes. Equivalent to
Duration::seconds(minutes * 60)
.
assert_eq!(Duration::minutes(1), 60.seconds());Run
pub const fn seconds(seconds: i64) -> Self
[src]
Create a new Duration
with the given number of seconds.
assert_eq!(Duration::seconds(1), 1_000.milliseconds());Run
pub fn seconds_f64(seconds: f64) -> Self
[src]
Creates a new Duration
from the specified number of seconds represented as f64
.
assert_eq!(Duration::seconds_f64(0.5), 0.5.seconds()); assert_eq!(Duration::seconds_f64(-0.5), -0.5.seconds());Run
pub fn seconds_f32(seconds: f32) -> Self
[src]
Creates a new Duration
from the specified number of seconds represented as f32
.
assert_eq!(Duration::seconds_f32(0.5), 0.5.seconds()); assert_eq!(Duration::seconds_f32(-0.5), (-0.5).seconds());Run
pub const fn milliseconds(milliseconds: i64) -> Self
[src]
Create a new Duration
with the given number of milliseconds.
assert_eq!(Duration::milliseconds(1), 1_000.microseconds()); assert_eq!(Duration::milliseconds(-1), (-1_000).microseconds());Run
pub const fn microseconds(microseconds: i64) -> Self
[src]
Create a new Duration
with the given number of microseconds.
assert_eq!(Duration::microseconds(1), 1_000.nanoseconds()); assert_eq!(Duration::microseconds(-1), (-1_000).nanoseconds());Run
pub const fn nanoseconds(nanoseconds: i64) -> Self
[src]
Create a new Duration
with the given number of nanoseconds.
assert_eq!(Duration::nanoseconds(1), 1.microseconds() / 1_000); assert_eq!(Duration::nanoseconds(-1), (-1).microseconds() / 1_000);Run
pub const fn whole_weeks(self) -> i64
[src]
Get the number of whole weeks in the duration.
assert_eq!(1.weeks().whole_weeks(), 1); assert_eq!((-1).weeks().whole_weeks(), -1); assert_eq!(6.days().whole_weeks(), 0); assert_eq!((-6).days().whole_weeks(), 0);Run
pub const fn whole_days(self) -> i64
[src]
Get the number of whole days in the duration.
assert_eq!(1.days().whole_days(), 1); assert_eq!((-1).days().whole_days(), -1); assert_eq!(23.hours().whole_days(), 0); assert_eq!((-23).hours().whole_days(), 0);Run
pub const fn whole_hours(self) -> i64
[src]
Get the number of whole hours in the duration.
assert_eq!(1.hours().whole_hours(), 1); assert_eq!((-1).hours().whole_hours(), -1); assert_eq!(59.minutes().whole_hours(), 0); assert_eq!((-59).minutes().whole_hours(), 0);Run
pub const fn whole_minutes(self) -> i64
[src]
Get the number of whole minutes in the duration.
assert_eq!(1.minutes().whole_minutes(), 1); assert_eq!((-1).minutes().whole_minutes(), -1); assert_eq!(59.seconds().whole_minutes(), 0); assert_eq!((-59).seconds().whole_minutes(), 0);Run
pub const fn whole_seconds(self) -> i64
[src]
Get the number of whole seconds in the duration.
assert_eq!(1.seconds().whole_seconds(), 1); assert_eq!((-1).seconds().whole_seconds(), -1); assert_eq!(1.minutes().whole_seconds(), 60); assert_eq!((-1).minutes().whole_seconds(), -60);Run
pub fn as_seconds_f64(self) -> f64
[src]
Get the number of fractional seconds in the duration.
assert_eq!(1.5.seconds().as_seconds_f64(), 1.5); assert_eq!((-1.5).seconds().as_seconds_f64(), -1.5);Run
pub fn as_seconds_f32(self) -> f32
[src]
Get the number of fractional seconds in the duration.
assert_eq!(1.5.seconds().as_seconds_f32(), 1.5); assert_eq!((-1.5).seconds().as_seconds_f32(), -1.5);Run
pub const fn whole_milliseconds(self) -> i128
[src]
Get the number of whole milliseconds in the duration.
assert_eq!(1.seconds().whole_milliseconds(), 1_000); assert_eq!((-1).seconds().whole_milliseconds(), -1_000); assert_eq!(1.milliseconds().whole_milliseconds(), 1); assert_eq!((-1).milliseconds().whole_milliseconds(), -1);Run
pub const fn subsec_milliseconds(self) -> i16
[src]
Get the number of milliseconds past the number of whole seconds.
Always in the range -1_000..1_000
.
assert_eq!(1.4.seconds().subsec_milliseconds(), 400); assert_eq!((-1.4).seconds().subsec_milliseconds(), -400);Run
pub const fn whole_microseconds(self) -> i128
[src]
Get the number of whole microseconds in the duration.
assert_eq!(1.milliseconds().whole_microseconds(), 1_000); assert_eq!((-1).milliseconds().whole_microseconds(), -1_000); assert_eq!(1.microseconds().whole_microseconds(), 1); assert_eq!((-1).microseconds().whole_microseconds(), -1);Run
pub const fn subsec_microseconds(self) -> i32
[src]
Get the number of microseconds past the number of whole seconds.
Always in the range -1_000_000..1_000_000
.
assert_eq!(1.0004.seconds().subsec_microseconds(), 400); assert_eq!((-1.0004).seconds().subsec_microseconds(), -400);Run
pub const fn whole_nanoseconds(self) -> i128
[src]
Get the number of nanoseconds in the duration.
assert_eq!(1.microseconds().whole_nanoseconds(), 1_000); assert_eq!((-1).microseconds().whole_nanoseconds(), -1_000); assert_eq!(1.nanoseconds().whole_nanoseconds(), 1); assert_eq!((-1).nanoseconds().whole_nanoseconds(), -1);Run
pub const fn subsec_nanoseconds(self) -> i32
[src]
Get the number of nanoseconds past the number of whole seconds.
The returned value will always be in the range -1_000_000_000..1_000_000_000
.
assert_eq!(1.000_000_400.seconds().subsec_nanoseconds(), 400); assert_eq!((-1.000_000_400).seconds().subsec_nanoseconds(), -400);Run
pub const fn checked_add(self, rhs: Self) -> Option<Self>
[src]
Computes self + rhs
, returning None
if an overflow occurred.
assert_eq!(5.seconds().checked_add(5.seconds()), Some(10.seconds())); assert_eq!(Duration::MAX.checked_add(1.nanoseconds()), None); assert_eq!((-5).seconds().checked_add(5.seconds()), Some(0.seconds()));Run
This feature is const fn
when using rustc >= 1.47.
pub const fn checked_sub(self, rhs: Self) -> Option<Self>
[src]
Computes self - rhs
, returning None
if an overflow occurred.
assert_eq!(5.seconds().checked_sub(5.seconds()), Some(Duration::ZERO)); assert_eq!(Duration::MIN.checked_sub(1.nanoseconds()), None); assert_eq!(5.seconds().checked_sub(10.seconds()), Some((-5).seconds()));Run
This feature is const fn
when using rustc >= 1.47.
pub const fn checked_mul(self, rhs: i32) -> Option<Self>
[src]
Computes self * rhs
, returning None
if an overflow occurred.
assert_eq!(5.seconds().checked_mul(2), Some(10.seconds())); assert_eq!(5.seconds().checked_mul(-2), Some((-10).seconds())); assert_eq!(5.seconds().checked_mul(0), Some(0.seconds())); assert_eq!(Duration::MAX.checked_mul(2), None); assert_eq!(Duration::MIN.checked_mul(2), None);Run
This feature is const fn
when using rustc >= 1.47.
pub const fn checked_div(self, rhs: i32) -> Option<Self>
[src]
Computes self / rhs
, returning None
if rhs == 0
.
assert_eq!(10.seconds().checked_div(2), Some(5.seconds())); assert_eq!(10.seconds().checked_div(-2), Some((-5).seconds())); assert_eq!(1.seconds().checked_div(0), None);Run
pub const fn saturating_add(self, rhs: Self) -> Self
[src]
Computes self + rhs
, saturating if an overflow occurred.
assert_eq!(5.seconds().saturating_add(5.seconds()), 10.seconds()); assert_eq!(Duration::MAX.saturating_add(1.nanoseconds()), Duration::MAX); assert_eq!( Duration::MIN.saturating_add((-1).nanoseconds()), Duration::MIN ); assert_eq!((-5).seconds().saturating_add(5.seconds()), Duration::ZERO);Run
This feature is const fn
when using rustc >= 1.47.
pub const fn saturating_sub(self, rhs: Self) -> Self
[src]
Computes self - rhs
, saturating if an overflow occurred.
assert_eq!(5.seconds().saturating_sub(5.seconds()), Duration::ZERO); assert_eq!(Duration::MIN.saturating_sub(1.nanoseconds()), Duration::MIN); assert_eq!( Duration::MAX.saturating_sub((-1).nanoseconds()), Duration::MAX ); assert_eq!(5.seconds().saturating_sub(10.seconds()), (-5).seconds());Run
This feature is const fn
when using rustc >= 1.47.
pub const fn saturating_mul(self, rhs: i32) -> Self
[src]
Computes self * rhs
, saturating if an overflow occurred.
assert_eq!(5.seconds().saturating_mul(2), 10.seconds()); assert_eq!(5.seconds().saturating_mul(-2), (-10).seconds()); assert_eq!(5.seconds().saturating_mul(0), Duration::ZERO); assert_eq!(Duration::MAX.saturating_mul(2), Duration::MAX); assert_eq!(Duration::MIN.saturating_mul(2), Duration::MIN); assert_eq!(Duration::MAX.saturating_mul(-2), Duration::MIN); assert_eq!(Duration::MIN.saturating_mul(-2), Duration::MAX);Run
This feature is const fn
when using rustc >= 1.47.
pub fn time_fn<T>(f: impl FnOnce() -> T) -> (Self, T)
[src]
std
only.Runs a closure, returning the duration of time it took to run. The return value of the closure is provided in the second part of the tuple.
Trait Implementations
impl Add<Duration> for Date
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: Duration) -> Self::Output
[src]
impl Add<Duration> for Duration
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, rhs: Self) -> Self::Output
[src]
impl Add<Duration> for Duration
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, std_duration: StdDuration) -> Self::Output
[src]
impl Add<Duration> for Instant
[src]
std
only.type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: Duration) -> Self::Output
[src]
impl Add<Duration> for PrimitiveDateTime
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: Duration) -> Self::Output
[src]
impl Add<Duration> for Time
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: Duration) -> Self::Output
[src]
impl<T> AddAssign<T> for Duration where
Self: Add<T, Output = Self>,
[src]
Self: Add<T, Output = Self>,
fn add_assign(&mut self, rhs: T)
[src]
impl Arbitrary for Duration
[src]
quickcheck
only.impl Clone for Duration
[src]
impl Copy for Duration
[src]
impl Debug for Duration
[src]
impl Default for Duration
[src]
impl<'a> Deserialize<'a> for Duration
[src]
serde
only.fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error>
[src]
impl Div<Duration> for Duration
[src]
type Output = f64
The resulting type after applying the /
operator.
fn div(self, rhs: Self) -> Self::Output
[src]
impl Div<Duration> for Duration
[src]
type Output = f64
The resulting type after applying the /
operator.
fn div(self, rhs: StdDuration) -> Self::Output
[src]
impl Div<f32> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: f32) -> Self::Output
[src]
impl Div<f64> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: f64) -> Self::Output
[src]
impl Div<i16> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: i16) -> Self::Output
[src]
impl Div<i32> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: i32) -> Self::Output
[src]
impl Div<i8> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: i8) -> Self::Output
[src]
impl Div<u16> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: u16) -> Self::Output
[src]
impl Div<u32> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: u32) -> Self::Output
[src]
impl Div<u8> for Duration
[src]
type Output = Self
The resulting type after applying the /
operator.
fn div(self, rhs: u8) -> Self::Output
[src]
impl<T> DivAssign<T> for Duration where
Self: Div<T, Output = Self>,
[src]
Self: Div<T, Output = Self>,
fn div_assign(&mut self, rhs: T)
[src]
impl Eq for Duration
[src]
impl Hash for Duration
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Mul<f32> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: f32) -> Self::Output
[src]
impl Mul<f64> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: f64) -> Self::Output
[src]
impl Mul<i16> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: i16) -> Self::Output
[src]
impl Mul<i32> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: i32) -> Self::Output
[src]
impl Mul<i8> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: i8) -> Self::Output
[src]
impl Mul<u16> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: u16) -> Self::Output
[src]
impl Mul<u32> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: u32) -> Self::Output
[src]
impl Mul<u8> for Duration
[src]
type Output = Self
The resulting type after applying the *
operator.
fn mul(self, rhs: u8) -> Self::Output
[src]
impl<T> MulAssign<T> for Duration where
Self: Mul<T, Output = Self>,
[src]
Self: Mul<T, Output = Self>,
fn mul_assign(&mut self, rhs: T)
[src]
impl Neg for Duration
[src]
type Output = Self
The resulting type after applying the -
operator.
fn neg(self) -> Self::Output
[src]
impl Ord for Duration
[src]
fn cmp(&self, other: &Duration) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Duration> for Duration
[src]
impl PartialEq<Duration> for Duration
[src]
fn eq(&self, rhs: &StdDuration) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Duration> for Duration
[src]
fn partial_cmp(&self, other: &Duration) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Duration> for Duration
[src]
fn partial_cmp(&self, rhs: &StdDuration) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Serialize for Duration
[src]
serde
only.impl StructuralEq for Duration
[src]
impl StructuralPartialEq for Duration
[src]
impl Sub<Duration> for Date
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: Duration) -> Self::Output
[src]
impl Sub<Duration> for Duration
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, rhs: Self) -> Self::Output
[src]
impl Sub<Duration> for Duration
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, rhs: StdDuration) -> Self::Output
[src]
impl Sub<Duration> for Instant
[src]
std
only.type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: Duration) -> Self::Output
[src]
impl Sub<Duration> for PrimitiveDateTime
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: Duration) -> Self::Output
[src]
impl Sub<Duration> for Time
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: Duration) -> Self::Output
[src]
impl<T> SubAssign<T> for Duration where
Self: Sub<T, Output = Self>,
[src]
Self: Sub<T, Output = Self>,
fn sub_assign(&mut self, rhs: T)
[src]
impl TryFrom<Duration> for Duration
[src]
type Error = ConversionRange
The type returned in the event of a conversion error.
fn try_from(original: StdDuration) -> Result<Self, ConversionRange>
[src]
Auto Trait Implementations
impl RefUnwindSafe for Duration
impl Send for Duration
impl Sync for Duration
impl Unpin for Duration
impl UnwindSafe for Duration
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub 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]
U: TryFrom<T>,