Struct Duration 

pub struct Duration { /* private fields */ }

A Duration represents the difference between two time points. It has an associated Representation, which determines how the count of elapsed ticks is stored. The Period determines the integer (!) ratio of each tick to seconds. This may be used to convert between Durations of differing time units.

The accuracy of a Duration is one attosecond. This makes for a representable range of about 10 trillion years, or about 700 times the age of the universe; should be sufficient for most purposes. Note that this type is explicitly intended for calculations only: when storing large numbers of durations, it might be more efficient to use a more tailor-made representation.

Implementations

impl Duration

pub const fn attoseconds(count: i128) -> Self

Constructs a new Duration from a given number of attoseconds.

pub const fn femtoseconds(count: i128) -> Self

Constructs a new Duration from a given number of femtoseconds.

pub const fn picoseconds(count: i128) -> Self

Constructs a new Duration from a given number of picoseconds.

pub const fn nanoseconds(count: i128) -> Self

Constructs a new Duration from a given number of nanoseconds.

pub const fn microseconds(count: i128) -> Self

Constructs a new Duration from a given number of microseconds.

pub const fn milliseconds(count: i128) -> Self

Constructs a new Duration from a given number of milliseconds.

pub const fn seconds(count: i128) -> Self

Constructs a new Duration from a given number of seconds.

pub const fn minutes(count: i128) -> Self

Constructs a new Duration from a given number of minutes.

pub const fn hours(count: i128) -> Self

Constructs a new Duration from a given number of hours.

pub const fn days(count: i128) -> Self

Constructs a new Duration from a given number of days.

pub const fn weeks(count: i128) -> Self

Constructs a new Duration from a given number of weeks.

pub const fn months(count: i128) -> Self

Constructs a new Duration from a given number of months. Expresses a month as 1/12 of an average Gregorian year.

pub const fn years(count: i128) -> Self

Constructs a new Duration from a given number of years. Uses an average Gregorian year as duration.

pub const fn count(&self) -> i128

Returns the raw number of time units contained in this Duration. It is advised not to use this function unless absolutely necessary, as it effectively throws away all time unit information and safety.

pub fn fractional_digits( &self, precision: Option<usize>, base: u8, ) -> impl Iterator<Item = u8>

Returns an iterator over the fractional (sub-unit) digits of this duration. Useful as helper function when printing durations.

pub fn decimal_digits( &self, precision: Option<usize>, ) -> impl Iterator<Item = u8>

Returns an iterator over the fractional (sub-unit) digits of this duration, expressed in decimal. Useful as helper function when printing durations.

pub const fn round<Target>(self) -> Duration

where Target: UnitRatio + ?Sized,

Converts towards a different time unit, rounding towards the nearest whole unit.

pub fn ceil<Target>(self) -> Duration

where Target: UnitRatio + ?Sized,

Converts towards a different time unit, rounding towards positive infinity if the unit is not entirely commensurate with the present unit.

pub fn floor<Target>(self) -> Duration

where Target: UnitRatio + ?Sized,

Converts towards a different time unit, rounding towards negative infinity if the unit is not entirely commensurate with the present unit.

pub const fn truncate<Target>(self) -> Duration

where Target: UnitRatio + ?Sized,

Converts towards a different time unit, rounding towards zero if the unit is not entirely commensurate with the present unit.

pub fn factor_out<Unit>(self) -> (i128, Duration)

where Unit: UnitRatio + ?Sized,

Segments this Duration by factoring out the largest possible number of whole multiples of a given unit. Returns this whole number as well as the remainder.

An example would be factoring out the number of whole days from some elapsed time: then, self.factor_out() would return a tuple of the number of whole days and the fractional day part that remains.

pub const fn div_round(self, other: i128) -> Self

Divides by an i128, rounding to the nearest result.

impl Duration

pub fn abs(&self) -> Self

pub fn abs_sub(&self, other: &Self) -> Self

pub fn signum(&self) -> Self

pub fn is_positive(&self) -> bool

pub fn is_negative(&self) -> bool

Trait Implementations

impl<Scale> Add<Duration> for TimePoint<Scale>

where Scale: ?Sized,

type Output = TimePoint<Scale>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Duration

type Output = Duration

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Scale> AddAssign<Duration> for TimePoint<Scale>

where Scale: ?Sized,

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl AddAssign for Duration

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Bounded for Duration

fn min_value() -> Self

Returns the Duration value that is nearest to negative infinity.

fn max_value() -> Self

Returns the Duration value that is nearest to positive infinity.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstZero for Duration

const ZERO: Self

The additive identity element of Self, 0.

impl Debug for Duration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Duration

where Self: FromStr, <Self as FromStr>::Err: Display,

Available on crate feature serde only.

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<T> Div<T> for Duration

where T: Into<i128>,

fn div(self, rhs: T) -> Self::Output

A Duration may may be divided by unitless numbers to obtain a new Duration.

type Output = Duration

The resulting type after applying the / operator.

impl Div for Duration

type Output = i128

The resulting type after applying the / operator.

fn div(self, rhs: Duration) -> Self::Output

Performs the / operation.

impl From<Days> for Duration

fn from(value: Days) -> Self

Converts to this type from the input type.

impl FromStr for Duration

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

Parses a Duration type based on some ISO 8601 duration string. However, we additionally impose that months may not be used as duration, to prevent confusion with minutes (and because their precise duration cannot be unambiguously defined). Furthermore, we do not support use of the time designator (‘T’) inside duration expressions. Finally, we support years, days, hours, minutes, and seconds with any number of digits.

For years, following the rest of this library, a duration of 31556952 seconds is used, which corresponds with the exact average duration of a Gregorian year.

type Err = DurationParsingError

The associated error which can be returned from parsing.

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<T> Mul<T> for Duration

where T: Into<i128>,

fn mul(self, rhs: T) -> Self::Output

A Duration may not be multiplied with another Duration (as that is undefined), but it may be multiplied with unitless numbers.

type Output = Duration

The resulting type after applying the * operator.

impl Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Duration

Performs the unary - operation.

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

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<Scale> Sub<Duration> for TimePoint<Scale>

where Scale: ?Sized,

type Output = TimePoint<Scale>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Duration

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Scale> SubAssign<Duration> for TimePoint<Scale>

where Scale: ?Sized,

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl SubAssign for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl Zero for Duration

fn zero() -> Self

Returns a Duration value that represents no time passed.

fn is_zero(&self) -> bool

Whether this Duration has any duration.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration