Struct Duration 

pub struct Duration(pub Duration);

Tuple Fields

0: Duration

Implementations

impl Duration

pub fn walk_revisioned_field_names( wire_revision: u16, ) -> &'static [&'static str]

Field names at the given wire revision in declaration order. Returns an empty slice if the revision is unknown. Generated by the revisioned derive.

impl Duration

pub const REVISION: u16 = 1u16

The revision number of this type, as declared via #[revisioned(revision = N)].

impl Duration

pub const MAX: Duration

pub const ZERO: Duration

impl Duration

pub fn new(secs: u64, nanos: u32) -> Duration

Create a duration from both seconds and nanoseconds components

pub fn nanos(&self) -> u128

Get the total number of nanoseconds

pub fn micros(&self) -> u128

Get the total number of microseconds

pub fn millis(&self) -> u128

Get the total number of milliseconds

pub fn secs(&self) -> u64

Get the total number of seconds

pub fn mins(&self) -> u64

Get the total number of minutes

pub fn hours(&self) -> u64

Get the total number of hours

pub fn days(&self) -> u64

Get the total number of dats

pub fn weeks(&self) -> u64

Get the total number of months

pub fn years(&self) -> u64

Get the total number of years

pub fn from_nanos(nanos: u64) -> Duration

Create a duration from nanoseconds

pub fn from_micros(micros: u64) -> Duration

Create a duration from microseconds

pub fn from_millis(millis: u64) -> Duration

Create a duration from milliseconds

pub fn from_secs(secs: u64) -> Duration

Create a duration from seconds

pub fn from_mins(mins: u64) -> Option<Duration>

Create a duration from minutes

pub fn from_hours(hours: u64) -> Option<Duration>

Create a duration from hours

pub fn from_days(days: u64) -> Option<Duration>

Create a duration from days

pub fn from_weeks(weeks: u64) -> Option<Duration>

Create a duration from weeks

Methods from Deref<Target = Duration>

pub fn is_zero(&self) -> bool

Returns true if this Duration spans no time.

Examples

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 fn as_secs(&self) -> u64

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.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730_023_852);
assert_eq!(duration.as_secs(), 5);

To determine the total number of seconds represented by the Duration including the fractional part, use as_secs_f64 or as_secs_f32

pub fn subsec_millis(&self) -> u32

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).

Examples

use std::time::Duration;

let duration = Duration::from_millis(5_432);
assert_eq!(duration.as_secs(), 5);
assert_eq!(duration.subsec_millis(), 432);

pub fn subsec_micros(&self) -> u32

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).

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);

pub fn subsec_nanos(&self) -> u32

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).

Examples

use std::time::Duration;

let duration = Duration::from_millis(5_010);
assert_eq!(duration.as_secs(), 5);
assert_eq!(duration.subsec_nanos(), 10_000_000);

pub fn as_millis(&self) -> u128

Returns the total number of whole milliseconds contained by this Duration.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730_023_852);
assert_eq!(duration.as_millis(), 5_730);

pub fn as_micros(&self) -> u128

Returns the total number of whole microseconds contained by this Duration.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730_023_852);
assert_eq!(duration.as_micros(), 5_730_023);

pub fn as_nanos(&self) -> u128

Returns the total number of nanoseconds contained by this Duration.

Examples

use std::time::Duration;

let duration = Duration::new(5, 730_023_852);
assert_eq!(duration.as_nanos(), 5_730_023_852);

pub fn abs_diff(self, other: Duration) -> Duration

Computes the absolute difference between self and other.

Examples

use std::time::Duration;

assert_eq!(Duration::new(100, 0).abs_diff(Duration::new(80, 0)), Duration::new(20, 0));
assert_eq!(Duration::new(100, 400_000_000).abs_diff(Duration::new(110, 0)), Duration::new(9, 600_000_000));

pub fn checked_add(self, rhs: Duration) -> Option<Duration>

Checked Duration addition. Computes self + other, returning None if overflow occurred.

Examples

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 saturating_add(self, rhs: Duration) -> Duration

Saturating Duration addition. Computes self + other, returning Duration::MAX if overflow occurred.

Examples

use std::time::Duration;

assert_eq!(Duration::new(0, 0).saturating_add(Duration::new(0, 1)), Duration::new(0, 1));
assert_eq!(Duration::new(1, 0).saturating_add(Duration::new(u64::MAX, 0)), Duration::MAX);

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

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 saturating_sub(self, rhs: Duration) -> Duration

Saturating Duration subtraction. Computes self - other, returning Duration::ZERO if the result would be negative or if overflow occurred.

Examples

use std::time::Duration;

assert_eq!(Duration::new(0, 1).saturating_sub(Duration::new(0, 0)), Duration::new(0, 1));
assert_eq!(Duration::new(0, 0).saturating_sub(Duration::new(0, 1)), Duration::ZERO);

pub fn checked_mul(self, rhs: u32) -> Option<Duration>

Checked Duration multiplication. Computes self * other, returning None if overflow occurred.

Examples

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 saturating_mul(self, rhs: u32) -> Duration

Saturating Duration multiplication. Computes self * other, returning Duration::MAX if overflow occurred.

Examples

use std::time::Duration;

assert_eq!(Duration::new(0, 500_000_001).saturating_mul(2), Duration::new(1, 2));
assert_eq!(Duration::new(u64::MAX - 1, 0).saturating_mul(2), Duration::MAX);

pub fn checked_div(self, rhs: u32) -> Option<Duration>

Checked Duration division. Computes self / other, returning None if other == 0.

Examples

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

Returns the number of seconds contained by this Duration as f64.

The returned value includes the fractional (nanosecond) part of the duration.

Examples

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

Returns the number of seconds contained by this Duration as f32.

The returned value includes the fractional (nanosecond) part of the duration.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
assert_eq!(dur.as_secs_f32(), 2.7);

pub fn as_millis_f64(&self) -> f64

🔬This is a nightly-only experimental API. (duration_millis_float)

Returns the number of milliseconds contained by this Duration as f64.

The returned value includes the fractional (nanosecond) part of the duration.

Examples

#![feature(duration_millis_float)]
use std::time::Duration;

let dur = Duration::new(2, 345_678_000);
assert_eq!(dur.as_millis_f64(), 2_345.678);

pub fn as_millis_f32(&self) -> f32

🔬This is a nightly-only experimental API. (duration_millis_float)

Returns the number of milliseconds contained by this Duration as f32.

The returned value includes the fractional (nanosecond) part of the duration.

Examples

#![feature(duration_millis_float)]
use std::time::Duration;

let dur = Duration::new(2, 345_678_000);
assert_eq!(dur.as_millis_f32(), 2_345.678);

pub fn mul_f64(self, rhs: f64) -> Duration

Multiplies Duration by f64.

Panics

This method will panic if result is negative, overflows Duration or not finite.

Examples

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));

Note that f64 does not have enough bits (f64::MANTISSA_DIGITS) to represent the full range of possible Duration with nanosecond precision, so rounding may occur even for trivial operations like multiplying by 1.

use std::time::Duration;

// This is about 14.9 weeks, remaining precise to the nanosecond:
let weeks = Duration::from_nanos(f64::MAX_EXACT_INTEGER as u64);
assert_eq!(weeks, weeks.mul_f64(1.0));

// A larger value incurs rounding in the floating-point operation:
let weeks = Duration::from_nanos(u64::MAX);
assert_ne!(weeks, weeks.mul_f64(1.0));

// This is over 285 million years, remaining precise to the second:
let years = Duration::from_secs(f64::MAX_EXACT_INTEGER as u64);
assert_eq!(years, years.mul_f64(1.0));

// And again larger values incur rounding:
let years = Duration::from_secs(u64::MAX / 2);
assert_ne!(years, years.mul_f64(1.0));

// In the extreme, rounding can even overflow `Duration`, which panics.
let _ = Duration::from_secs(u64::MAX).mul_f64(1.0);

pub fn mul_f32(self, rhs: f32) -> Duration

Multiplies Duration by f32.

Since the significand of f32 is quite limited compared to the range of Duration – only about 16.8ms of exact nanosecond precision – this method currently forwards to mul_f64 for greater accuracy.

Panics

This method will panic if result is negative, overflows Duration or not finite.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
// Note that this `3.14_f32` argument already has more floating-point
// representation error than a direct `3.14_f64` would, so the result
// is slightly different from the ideal 8.478s.
assert_eq!(dur.mul_f32(3.14), Duration::new(8, 478_000_283));
assert_eq!(dur.mul_f32(3.14e5), Duration::new(847_800, 0));

pub fn div_f64(self, rhs: f64) -> Duration

Divides Duration by f64.

Panics

This method will panic if result is negative, overflows Duration or not finite.

Examples

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));
assert_eq!(dur.div_f64(3.14e5), Duration::new(0, 8_599));

Note that f64 does not have enough bits (f64::MANTISSA_DIGITS) to represent the full range of possible Duration with nanosecond precision, so rounding may occur even for trivial operations like dividing by 1.

use std::time::Duration;

// This is about 14.9 weeks, remaining precise to the nanosecond:
let weeks = Duration::from_nanos(f64::MAX_EXACT_INTEGER as u64);
assert_eq!(weeks, weeks.div_f64(1.0));

// A larger value incurs rounding in the floating-point operation:
let weeks = Duration::from_nanos(u64::MAX);
assert_ne!(weeks, weeks.div_f64(1.0));

// This is over 285 million years, remaining precise to the second:
let years = Duration::from_secs(f64::MAX_EXACT_INTEGER as u64);
assert_eq!(years, years.div_f64(1.0));

// And again larger values incur rounding:
let years = Duration::from_secs(u64::MAX / 2);
assert_ne!(years, years.div_f64(1.0));

// In the extreme, rounding can even overflow `Duration`, which panics.
let _ = Duration::from_secs(u64::MAX).div_f64(1.0);

pub fn div_f32(self, rhs: f32) -> Duration

Divides Duration by f32.

Since the significand of f32 is quite limited compared to the range of Duration – only about 16.8ms of exact nanosecond precision – this method currently forwards to div_f64 for greater accuracy.

Panics

This method will panic if result is negative, overflows Duration or not finite.

Examples

use std::time::Duration;

let dur = Duration::new(2, 700_000_000);
// Note that this `3.14_f32` argument already has more floating-point
// representation error than a direct `3.14_f64` would, so the result
// is slightly different from the ideally rounded 0.859_872_611.
assert_eq!(dur.div_f32(3.14), Duration::new(0, 859_872_583));
assert_eq!(dur.div_f32(3.14e5), Duration::new(0, 8_599));

pub fn div_duration_f64(self, rhs: Duration) -> f64

Divides Duration by Duration and returns f64.

Examples

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

Divides Duration by Duration and returns f32.

Examples

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);

pub fn div_duration_floor(self, rhs: Duration) -> u128

🔬This is a nightly-only experimental API. (duration_integer_division)

Divides Duration by Duration and returns u128, rounding the result towards zero.

Examples

#![feature(duration_integer_division)]
use std::time::Duration;

let dur = Duration::new(2, 0);
assert_eq!(dur.div_duration_floor(Duration::new(1, 000_000_001)), 1);
assert_eq!(dur.div_duration_floor(Duration::new(1, 000_000_000)), 2);
assert_eq!(dur.div_duration_floor(Duration::new(0, 999_999_999)), 2);

pub fn div_duration_ceil(self, rhs: Duration) -> u128

🔬This is a nightly-only experimental API. (duration_integer_division)

Divides Duration by Duration and returns u128, rounding the result towards positive infinity.

Examples

#![feature(duration_integer_division)]
use std::time::Duration;

let dur = Duration::new(2, 0);
assert_eq!(dur.div_duration_ceil(Duration::new(1, 000_000_001)), 2);
assert_eq!(dur.div_duration_ceil(Duration::new(1, 000_000_000)), 2);
assert_eq!(dur.div_duration_ceil(Duration::new(0, 999_999_999)), 3);

Trait Implementations

impl Add for Duration

type Output = Duration

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<'b> Add<&'b Duration> for &Duration

type Output = Duration

The resulting type after applying the + operator.

fn add(self, other: &'b Duration) -> Duration

Performs the + operation.

impl Add<Datetime> for Duration

type Output = Datetime

The resulting type after applying the + operator.

fn add(self, other: Datetime) -> Datetime

Performs the + operation.

impl<'de> BorrowDecode<'de, IndexFormat> for Duration

fn borrow_decode(_r: &mut BorrowReader<'de>) -> Result<Self, DecodeError>

impl<'de> BorrowDecode<'de> for Duration

fn borrow_decode(_r: &mut BorrowReader<'de>) -> Result<Self, DecodeError>

impl Cast for Duration

fn can_cast(v: &Value) -> bool

Returns true if calling cast on the value will succeed.

fn cast(v: Value) -> Result<Self, CastError>

Cast a value to the self type.

impl Clone for Duration

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Coerce for Duration

fn can_coerce(v: &Value) -> bool

Returns if calling coerce on the value will succeed or not.

fn coerce(v: Value) -> Result<Self, CoerceError>

Coerce a value.

impl Copy for Duration

impl Debug for Duration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Duration

type Target = Duration

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DeserializeRevisioned for Duration

fn deserialize_revisioned<R: Read>(reader: &mut R) -> Result<Self, Error>

Deserializes a new instance of the struct from the specified reader.

impl Display for Duration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for Duration

fn encode<W: Write>(&self, _w: &mut Writer<W>) -> Result<(), EncodeError>

impl Encode<IndexFormat> for Duration

fn encode<W: Write>(&self, _w: &mut Writer<W>) -> Result<(), EncodeError>

impl Eq for Duration

impl From<Duration> for Duration

fn from(v: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for Duration

fn from(s: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for PublicDuration

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for Duration

fn from(value: PublicDuration) -> Self

Converts to this type from the input type.

impl From<Duration> for Value

fn from(v: Duration) -> Self

Converts to this type from the input type.

impl FromStr for Duration

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HasKind for Duration

fn kind() -> Kind

impl Hash for Duration

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl InfoStructure for Duration

fn structure(self) -> Value

impl Ord for Duration

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Duration

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Duration

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Revisioned for Duration

fn revision() -> u16

Returns the current revision of this type.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl SerializeRevisioned for Duration

fn serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specified writer.

impl SkipCheckRevisioned for Duration

fn skip_check_revisioned<R: Read>(reader: &mut R) -> Result<(), Error>

impl SkipRevisioned for Duration

fn skip_revisioned<R: Read>(reader: &mut R) -> Result<(), Error>

fn skip_revisioned_slice(reader: &mut SliceReader<'_>) -> Result<(), Error>

Consume through bytes backed by SliceReader without allocating a buffer for bulk segments.

impl StructuralPartialEq for Duration

impl Sub for Duration

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<'b> Sub<&'b Duration> for &Duration

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: &'b Duration) -> Duration

Performs the - operation.

impl Sub<Datetime> for Duration

type Output = Datetime

The resulting type after applying the - operator.

fn sub(self, other: Datetime) -> Datetime

Performs the - operation.

impl Sum for Duration

fn sum<I>(iter: I) -> Duration

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a Duration> for Duration

fn sum<I>(iter: I) -> Duration

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl ToSql for Duration

fn fmt_sql(&self, f: &mut String, sql_fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.

impl TryAdd for Duration

type Output = Duration

fn try_add(self, other: Self) -> Result<Self>

impl<'b> TryAdd<&'b Duration> for &Duration

type Output = Duration

fn try_add(self, other: &'b Duration) -> Result<Duration>

impl TryAdd<Datetime> for Duration

type Output = Datetime

fn try_add(self, other: Datetime) -> Result<Datetime>

impl TrySub for Duration

type Output = Duration

fn try_sub(self, other: Self) -> Result<Self>

impl<'b> TrySub<&'b Duration> for &Duration

type Output = Duration

fn try_sub(self, other: &'b Duration) -> Result<Duration>

impl TrySub<Datetime> for Duration

type Output = Datetime

fn try_sub(self, other: Datetime) -> Result<Datetime>

impl WalkRevisioned for Duration

type Walker<'r, R: BorrowedReader + 'r> = DurationWalker<'r, R>

Walker produced by walk_revisioned.

fn walk_revisioned<'r, R: BorrowedReader>( reader: &'r mut R, ) -> Result<Self::Walker<'r, R>, Error>

Read the type’s revision-level prefix and return a walker positioned at the start of the body.