Struct Duration 

pub struct Duration(/* private fields */);

A duration of time.

Duration can be negative. Internally duration is represented as milliseconds.

Implementations

impl Duration

pub const ZERO: Self

pub const MAX: Self

pub const fn hours(hours: i64) -> Self

Create a duration instance from hours

pub const fn minutes(minutes: i64) -> Self

Create a duration instance from minutes.

pub const fn seconds(seconds: i64) -> Self

Create a duration instance from seconds.

pub const fn millis(ms: i64) -> Self

Create a duration instance from ms.

pub fn abs(&self) -> Self

pub const fn as_millis(&self) -> i64

Returns the number of whole milliseconds in the Duration instance.

pub const fn as_millis_unsigned(&self) -> u64

Returns the number of non-negative whole milliseconds in the Duration instance.

pub const fn as_seconds(&self) -> i64

Returns the number of whole seconds in the Duration instance.

pub const fn as_seconds_unsigned(&self) -> u64

Returns the number of non-negative whole seconds in the Duration instance.

pub const fn as_minutes(&self) -> i64

Returns the number of whole minutes in the Duration instance.

pub const fn is_non_negative(&self) -> bool

Returns true if duration is >= 0.

pub const fn is_positive(&self) -> bool

Returns true if duration is > 0.

Methods from Deref<Target = i64>

pub const MIN: i64

pub const MAX: i64

pub const BITS: u32 = u64::BITS

Trait Implementations

impl Add<Duration> for Time

type Output = Time

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) -> Self::Output

Performs the + operation.

impl AddAssign<Duration> for Time

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 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 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 = i64

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Duration

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

Formats the value using the given formatter.

impl Div<f64> for Duration

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i64> for Duration

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Duration

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Duration

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl DivAssign<i64> for Duration

fn div_assign(&mut self, rhs: i64)

Performs the /= operation.

impl From<Duration> for Duration

fn from(input: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for Duration

fn from(input: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for f64

fn from(num: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for i64

fn from(time: Duration) -> Self

Converts to this type from the input type.

impl From<f64> for Duration

fn from(num: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Duration

fn from(value: i64) -> Self

Converts to this type from the input type.

impl FromStr for Duration

Parses Duration from str

Example

assert_eq!(Duration::millis(2), Duration::from_str("2ms").unwrap());
assert_eq!(Duration::seconds(3), Duration::from_str("3s").unwrap());
assert_eq!(Duration::minutes(4), Duration::from_str("4m").unwrap());
assert_eq!(Duration::hours(5), Duration::from_str("5h").unwrap());

assert_eq!(
    Duration::hours(5) + Duration::minutes(2),
    Duration::from_str("5h2m").unwrap()
);
assert_eq!(
    Duration::hours(5) + Duration::minutes(2) + Duration::millis(1123),
    Duration::from_str("5h2m1s123ms").unwrap()
);
assert_eq!(
    Duration::seconds(5) - Duration::minutes(2),
    Duration::from_str("-1m55s").unwrap()
);

type Err = DurationParseError

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

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Duration> for i64

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i64> for Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Duration

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign<i64> for Duration

fn mul_assign(&mut self, rhs: i64)

Performs the *= operation.

impl Neg for Duration

type Output = Duration

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

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<Duration> 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 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<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: &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 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 Rem<Duration> for Time

type Output = Duration

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for Duration

type Output = Duration

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for Duration

fn rem_assign(&mut self, rhs: Duration)

Performs the %= operation.

impl Sub<Duration> for Time

type Output = Time

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) -> Self::Output

Performs the - operation.

impl SubAssign<Duration> for Time

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

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

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

impl TryFrom<Duration> for Time

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(duration: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration