Struct hifitime::Duration

pub struct Duration(_);

Defines generally usable durations for high precision math with Epoch (all data is stored in seconds)

Implementations

impl Duration

pub fn from_days(days: Decimal) -> Self

pub fn from_hours(hours: Decimal) -> Self

pub fn from_minutes(minutes: Decimal) -> Self

pub fn from_seconds(seconds: Decimal) -> Self

pub fn from_milliseconds(ms: Decimal) -> Self

pub fn from_microseconds(ms: Decimal) -> Self

pub fn from_nanoseconds(ns: Decimal) -> Self

pub fn from_f64(value: f64, unit: TimeUnit) -> Self

Creates a new duration from the provided unit

pub fn from_fraction(num: i64, denom: i64, unit: TimeUnit) -> Self

Creates a new duration from the provided fraction and unit

pub fn in_unit_f64(&self, unit: TimeUnit) -> f64

Returns this duration in f64 in the provided unit. For high fidelity comparisons, it is recommended to keep using the Duration structure.

pub fn in_unit(&self, unit: TimeUnit) -> Decimal

Returns the value of this duration in the requested unit.

Trait Implementations

impl Add<Duration> for Epoch

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: Duration) -> Self

Performs the + operation.

impl Add<Duration> for Duration

type Output = Duration

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Duration

Performs the + operation.

impl Add<TimeUnit> for Duration

type Output = Duration

The resulting type after applying the + operator.

fn add(self, rhs: TimeUnit) -> Duration

Performs the + operation.

impl AddAssign<Duration> for Epoch

fn add_assign(&mut self, duration: Duration)

Performs the += operation.

impl AddAssign<Duration> for Duration

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign<TimeUnit> for Duration

fn add_assign(&mut self, rhs: TimeUnit)

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

impl Debug for Duration

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

Formats the value using the given formatter.

impl Display for Duration

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

Formats the value using the given formatter.

impl Div<f32> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: f32) -> Duration

Performs the / operation.

impl Div<f64> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: f64) -> Duration

Performs the / operation.

impl Div<i16> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: i16) -> Duration

Performs the / operation.

impl Div<i32> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: i32) -> Duration

Performs the / operation.

impl Div<i64> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: i64) -> Duration

Performs the / operation.

impl Div<i8> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: i8) -> Duration

Performs the / operation.

impl Div<u128> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: u128) -> Duration

Performs the / operation.

impl Div<u16> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: u16) -> Duration

Performs the / operation.

impl Div<u32> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: u32) -> Duration

Performs the / operation.

impl Div<u64> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: u64) -> Duration

Performs the / operation.

impl Div<u8> for Duration

type Output = Duration

The resulting type after applying the / operator.

fn div(self, q: u8) -> Duration

Performs the / operation.

impl FromStr for Duration

type Err = Errors

The associated error which can be returned from parsing.

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

Attempts to convert a simple string to a Duration. Does not yet support complicated durations.

Identifiers: + d, days, day + h, hours, hour + min, mins, minute + s, second, seconds + ms, millisecond, milliseconds + us, microsecond, microseconds + ns, nanosecond, nanoseconds

Example

use hifitime::{Duration, TimeUnit};
use std::str::FromStr;

assert_eq!(Duration::from_str("1 d").unwrap(), TimeUnit::Day * 1);
assert_eq!(Duration::from_str("10.598 days").unwrap(), TimeUnit::Day * 10.598);
assert_eq!(Duration::from_str("10.598 min").unwrap(), TimeUnit::Minute * 10.598);
assert_eq!(Duration::from_str("10.598 us").unwrap(), TimeUnit::Microsecond * 10.598);
assert_eq!(Duration::from_str("10.598 seconds").unwrap(), TimeUnit::Second * 10.598);
assert_eq!(Duration::from_str("10.598 nanosecond").unwrap(), TimeUnit::Nanosecond * 10.598);

impl LowerExp for Duration

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

Formats the value using the given formatter.

impl Mul<Duration> for f32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for f64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u128

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u8

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for i8

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u16

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for i16

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for i32

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for u64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<Duration> for i64

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: Duration) -> Duration

Performs the * operation.

impl Mul<f32> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: f32) -> Duration

Performs the * operation.

impl Mul<f64> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: f64) -> Duration

Performs the * operation.

impl Mul<i16> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: i16) -> Duration

Performs the * operation.

impl Mul<i32> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: i32) -> Duration

Performs the * operation.

impl Mul<i64> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: i64) -> Duration

Performs the * operation.

impl Mul<i8> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: i8) -> Duration

Performs the * operation.

impl Mul<u128> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: u128) -> Duration

Performs the * operation.

impl Mul<u16> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: u16) -> Duration

Performs the * operation.

impl Mul<u32> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: u32) -> Duration

Performs the * operation.

impl Mul<u64> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: u64) -> Duration

Performs the * operation.

impl Mul<u8> for Duration

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, q: u8) -> Duration

Performs the * operation.

impl PartialEq<Duration> for Duration

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<TimeUnit> for Duration

fn eq(&self, unit: &TimeUnit) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Duration> 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: &Duration) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<TimeUnit> for Duration

fn partial_cmp(&self, unit: &TimeUnit) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl StructuralPartialEq for Duration

impl Sub<Duration> for Epoch

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: Duration) -> Self

Performs the - operation.

impl Sub<Duration> for Duration

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Duration

Performs the - operation.

impl Sub<TimeUnit> for Duration

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: TimeUnit) -> Duration

Performs the - operation.

impl SubAssign<Duration> for Epoch

fn sub_assign(&mut self, duration: Duration)

Performs the -= operation.

impl SubAssign<Duration> for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign<TimeUnit> for Duration

fn sub_assign(&mut self, rhs: TimeUnit)

Performs the -= operation.