Struct Duration

#[non_exhaustive]
pub struct Duration(pub Duration);

Tuple Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

0: Duration

Implementations

impl Duration

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

Create a duration from both seconds and nanoseconds components

pub fn to_raw(&self) -> String

Convert the Duration to a raw String

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

Create a duration from minutes

pub fn from_hours(hours: u64) -> Duration

Create a duration from hours

pub fn from_days(days: u64) -> Duration

Create a duration from days

pub fn from_weeks(days: u64) -> Duration

Create a duration from weeks

Methods from Deref<Target = Duration>

pub const SECOND: Duration = _

pub const MILLISECOND: Duration = _

pub const MICROSECOND: Duration = _

pub const NANOSECOND: Duration = _

pub const ZERO: Duration = _

pub const MAX: 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 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);

Trait Implementations

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

type Output = Duration

The resulting type after applying the + operator.

fn add(self, other: &'a 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 Add for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Duration

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

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Duration

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<'de> Deserialize<'de> for Duration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Duration

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

Formats the value using the given formatter.

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 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 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 Ord for Duration

fn cmp(&self, other: &Duration) -> 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.

impl PartialEq for Duration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Duration

fn partial_cmp(&self, other: &Duration) -> 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 serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specficifed writer.

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

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

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl Serialize for Duration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: &'a 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 Sub for Duration

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

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 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 TryFrom<&str> for Duration

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Strand> for Duration

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: Strand) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Duration

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration