Struct TimeSpan

pub struct TimeSpan { /* private fields */ }

An interval in between time stamps. This type is used to represent durations with nanosecond precision.

Implementations

impl TimeSpan

pub const ZERO: Self

Zero time span.

Represents duration between equal time points.

pub const NANOSECOND: Self

One nanosecond span. Minimal possible time span supported by this type.

pub const MICROSECOND: Self

One microsecond span.

pub const MILLISECOND: Self

One millisecond span.

pub const SECOND: Self

One second span.

pub const MINUTE: Self

One minute span.

pub const HOUR: Self

One hour span.

pub const DAY: Self

One day span.

pub const WEEK: Self

One week. Defined as 7 days.

pub const JULIAN_YEAR: Self

One Julian year. Average year length in Julian calendar. Defined as 365.25 days.

pub const GREGORIAN_YEAR: Self

One Gregorian year. Average year length in Gregorian calendar. Defined as 365.2425 days.

pub const SOLAR_YEAR: Self

One solar year (tropical year). Defined as 365.24219 days.

pub const YEAR: Self = Self::SOLAR_YEAR

One year. Closest value to the average length of a year on Earth.

pub const fn new(nanos: u64) -> TimeSpan

Constructs time span from number of nanoseconds.

pub const fn as_nanos(self) -> u64

Returns number of nanoseconds in this time span.

pub const fn as_micros(&self) -> u64

Returns number of microseconds this value represents.

pub const fn as_millis(&self) -> u64

Returns number of whole milliseconds this value represents.

pub const fn as_seconds(&self) -> u64

Returns number of whole seconds this value represents.

pub const fn as_minutes(&self) -> u64

Returns number of whole minutes this value represents.

pub const fn as_hours(&self) -> u64

Returns number of whole hours this value represents.

pub const fn as_days(&self) -> u64

Returns number of whole days this value represents.

pub const fn as_weeks(&self) -> u64

Returns number of whole weeks this value represents.

pub fn as_secs_f32(&self) -> f32

Returns number of seconds as floating point value. This function should be used for small-ish spans when high precision is not required.

pub fn as_secs_f64(&self) -> f64

Returns number of seconds as high precision floating point value.

pub const fn checked_add(self, span: TimeSpan) -> Option<TimeSpan>

Returns checked sum of two time spans.

pub const fn checked_sub(self, span: TimeSpan) -> Option<TimeSpan>

Returns checked difference of two time spans.

pub const fn checked_mul(self, value: u64) -> Option<TimeSpan>

Returns checked multiplication of time span by a number.

pub const fn checked_div(self, value: u64) -> Option<TimeSpan>

Returns checked division of time span by a number.

pub const fn div(self, value: NonZeroU64) -> TimeSpan

Returns the result of dividing this time span by a non-zero value.

pub const fn checked_div_span(self, span: TimeSpan) -> Option<u64>

Returns the result of dividing this time span by a non-zero time span.

pub const fn div_span(self, span: NonZeroTimeSpan) -> u64

Returns the result of dividing this time span by a non-zero time span.

pub const fn checked_rem(self, value: u64) -> Option<TimeSpan>

Returns checked remainder of time span divided by a number.

pub const fn rem(self, value: NonZeroU64) -> TimeSpan

Returns the remainder of time span divided by a non-zero value.

pub const fn checked_rem_span(self, span: TimeSpan) -> Option<TimeSpan>

Returns checked remainder of time span divided by a non-zero time span.

pub const fn rem_span(self, span: NonZeroTimeSpan) -> TimeSpan

Returns the remainder of time span divided by a non-zero time span.

pub const fn hms(hours: u64, minutes: u64, seconds: u64) -> TimeSpan

Constructs time span from number of days, hours, minutes and seconds.

pub const fn dhms(days: u64, hours: u64, minutes: u64, seconds: u64) -> TimeSpan

Constructs time span from number of days, hours, minutes and seconds.

Trait Implementations

impl Add<NonZeroTimeSpan> for TimeSpan

type Output = NonZeroTimeSpan

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TimeSpan> for NonZeroTimeSpan

type Output = NonZeroTimeSpan

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TimeSpan> for TimeStamp

type Output = TimeStamp

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for TimeSpan

type Output = TimeSpan

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<NonZeroTimeSpan> for TimeSpan

fn add_assign(&mut self, rhs: NonZeroTimeSpan)

Performs the += operation.

impl AddAssign<TimeSpan> for NonZeroTimeSpan

fn add_assign(&mut self, rhs: TimeSpan)

Performs the += operation.

impl AddAssign<TimeSpan> for TimeStamp

fn add_assign(&mut self, rhs: TimeSpan)

Performs the += operation.

impl AddAssign for TimeSpan

fn add_assign(&mut self, rhs: TimeSpan)

Performs the += operation.

impl Clone for TimeSpan

fn clone(&self) -> TimeSpan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSpan

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

Formats the value using the given formatter.

impl Display for TimeSpan

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

Formats the value using the given formatter.

impl Div<NonZero<u64>> for TimeSpan

type Output = TimeSpan

The resulting type after applying the / operator.

fn div(self, rhs: NonZeroU64) -> Self

Performs the / operation.

impl Div<NonZeroTimeSpan> for TimeSpan

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: NonZeroTimeSpan) -> u64

Performs the / operation.

impl Div<TimeSpan> for NonZeroTimeSpan

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: TimeSpan) -> u64

Performs the / operation.

impl Div<u64> for TimeSpan

type Output = TimeSpan

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self

Performs the / operation.

impl Div for TimeSpan

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: TimeSpan) -> u64

Performs the / operation.

impl DivAssign<NonZero<u64>> for TimeSpan

fn div_assign(&mut self, rhs: NonZeroU64)

Performs the /= operation.

impl DivAssign<u64> for TimeSpan

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl From<Duration> for TimeSpan

fn from(duration: Duration) -> Self

Converts to this type from the input type.

impl From<NonZeroTimeSpan> for TimeSpan

fn from(span: NonZeroTimeSpan) -> Self

Converts to this type from the input type.

impl From<TimeSpan> for Duration

fn from(span: TimeSpan) -> Self

Converts to this type from the input type.

impl FromStr for TimeSpan

type Err = TimeSpanParseErr

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 TimeSpan

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 Mul<NonZero<u64>> for TimeSpan

type Output = TimeSpan

The resulting type after applying the * operator.

fn mul(self, rhs: NonZeroU64) -> Self

Performs the * operation.

impl Mul<TimeSpan> for NonZeroU64

type Output = TimeSpan

The resulting type after applying the * operator.

fn mul(self, rhs: TimeSpan) -> TimeSpan

Performs the * operation.

impl Mul<TimeSpan> for u64

type Output = TimeSpan

The resulting type after applying the * operator.

fn mul(self, rhs: TimeSpan) -> TimeSpan

Performs the * operation.

impl Mul<u64> for TimeSpan

type Output = TimeSpan

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self

Performs the * operation.

impl MulAssign<NonZero<u64>> for TimeSpan

fn mul_assign(&mut self, rhs: NonZeroU64)

Performs the *= operation.

impl MulAssign<u64> for TimeSpan

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl Ord for TimeSpan

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

fn eq(&self, other: &TimeSpan) -> 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 TimeSpan

fn partial_cmp(&self, other: &TimeSpan) -> 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 Rem<NonZero<u64>> for TimeSpan

type Output = TimeSpan

The resulting type after applying the % operator.

fn rem(self, rhs: NonZeroU64) -> Self

Performs the % operation.

impl Rem<NonZeroTimeSpan> for TimeSpan

type Output = TimeSpan

The resulting type after applying the % operator.

fn rem(self, rhs: NonZeroTimeSpan) -> TimeSpan

Performs the % operation.

impl Rem<TimeSpan> for NonZeroTimeSpan

type Output = TimeSpan

The resulting type after applying the % operator.

fn rem(self, rhs: TimeSpan) -> TimeSpan

Performs the % operation.

impl Rem<u64> for TimeSpan

type Output = TimeSpan

The resulting type after applying the % operator.

fn rem(self, rhs: u64) -> Self

Performs the % operation.

impl Rem for TimeSpan

type Output = TimeSpan

The resulting type after applying the % operator.

fn rem(self, rhs: TimeSpan) -> TimeSpan

Performs the % operation.

impl RemAssign<NonZero<u64>> for TimeSpan

fn rem_assign(&mut self, rhs: NonZeroU64)

Performs the %= operation.

impl RemAssign<NonZeroTimeSpan> for TimeSpan

fn rem_assign(&mut self, rhs: NonZeroTimeSpan)

Performs the %= operation.

impl RemAssign<u64> for TimeSpan

fn rem_assign(&mut self, rhs: u64)

Performs the %= operation.

impl RemAssign for TimeSpan

fn rem_assign(&mut self, rhs: TimeSpan)

Performs the %= operation.

impl Sub<NonZeroTimeSpan> for TimeSpan

type Output = TimeSpan

The resulting type after applying the - operator.

fn sub(self, rhs: NonZeroTimeSpan) -> TimeSpan

Performs the - operation.

impl Sub<TimeSpan> for NonZeroTimeSpan

type Output = TimeSpan

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for TimeSpan

type Output = TimeSpan

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<NonZeroTimeSpan> for TimeSpan

fn sub_assign(&mut self, rhs: NonZeroTimeSpan)

Performs the -= operation.

impl SubAssign for TimeSpan

fn sub_assign(&mut self, rhs: TimeSpan)

Performs the -= operation.

impl TryFrom<TimeSpan> for NonZeroTimeSpan

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(span: TimeSpan) -> Result<Self, TryFromIntError>

Performs the conversion.

impl Copy for TimeSpan

impl Eq for TimeSpan

impl StructuralPartialEq for TimeSpan