Struct r3::time::Duration

pub struct Duration { /* private fields */ }

Represents a signed time span used by the API surface of R3-OS.

Duration is backed by i32 and can represent the range [-35′47.483648″, +35′47.483647″] with microsecond precision.

Implementations

impl Duration

pub const ZERO: Duration = Duration{ micros: 0,}

An empty interval.

pub const MAX: Duration = Duration{ micros: i32::MAX,}

The large representable positive time span (+35′47.483647″).

pub const MIN: Duration = Duration{ micros: i32::MIN,}

The large representable negative time span (-35′47.483648″).

pub const fn from_micros(micros: i32) -> Duration

Construct a new Duration from the specified number of microseconds.

pub const fn from_millis(millis: i32) -> Duration

Construct a new Duration from the specified number of milliseconds.

Pancis if millis overflows the representable range of Duration.

pub const fn from_secs(secs: i32) -> Duration

Construct a new Duration from the specified number of seconds.

Pancis if secs overflows the representable range of Duration.

pub const fn as_micros(self) -> i32

Get the total number of whole microseconds contained by this Duration.

pub const fn as_millis(self) -> i32

Get the total number of whole milliseconds contained by this Duration.

pub const fn as_secs(self) -> i32

Get the total number of whole seconds contained by this Duration.

pub const fn as_secs_f64(self) -> f64

Get the total number of seconds contained by this Duration as f64.

Examples

use r3_core::time::Duration;

let dur = Duration::from_micros(1_201_250_000);
assert_eq!(dur.as_secs_f64(), 1201.25);

pub const fn as_secs_f32(self) -> f32

Get the total number of seconds contained by this Duration as f32.

Examples

use r3_core::time::Duration;

let dur = Duration::from_micros(1_201_250_000);
assert_eq!(dur.as_secs_f32(), 1201.25);

pub const fn is_positive(self) -> bool

Return true if and only if self is positive.

pub const fn is_negative(self) -> bool

Return true if and only if self is negative.

pub const fn checked_mul(self, other: i32) -> Option<Duration>

Multiply self by the specified value, returning None if the result overflows.

pub const fn checked_div(self, other: i32) -> Option<Duration>

Divide self by the specified value, returning None if the result overflows or other is zero.

pub const fn checked_abs(self) -> Option<Duration>

Calculate the absolute value of self, returning None if self == MIN.

pub const fn checked_add(self, other: Duration) -> Option<Duration>

Add the specified value to self, returning None if the result overflows.

pub const fn checked_sub(self, other: Duration) -> Option<Duration>

Subtract the specified value from self, returning None if the result overflows.

Trait Implementations

impl Add<Duration> for Duration

fn add(self, rhs: Duration) -> <Duration as Add<Duration>>::Output

Perform a checked addition, panicking on overflow.

type Output = Duration

The resulting type after applying the + operator.

impl Add<Duration> for Time

fn add(self, rhs: Duration) -> <Time as Add<Duration>>::Output

Advance the time by duration and return the result.

type Output = Time

The resulting type after applying the + operator.

impl AddAssign<Duration> for Duration

fn add_assign(&mut self, rhs: Duration)

Perform a checked addition, panicking on overflow.

impl AddAssign<Duration> for Time

fn add_assign(&mut self, rhs: Duration)

Advance the time by duration in place.

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<(), Error>

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Duration

Returns the “default value” for a type.

impl Div<i32> for Duration

fn div(self, rhs: i32) -> <Duration as Div<i32>>::Output

Perform a checked division, panicking on overflow or when rhs is zero.

type Output = Duration

The resulting type after applying the / operator.

impl DivAssign<i32> for Duration

fn div_assign(&mut self, rhs: i32)

Perform a checked division, panicking on overflow or when rhs is zero.

impl Hash for Duration

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

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

const INIT: Duration = Self::ZERO

The default value.

impl Mul<i32> for Duration

fn mul(self, rhs: i32) -> <Duration as Mul<i32>>::Output

Perform a checked multiplication, panicking on overflow.

type Output = Duration

The resulting type after applying the * operator.

impl MulAssign<i32> for Duration

fn mul_assign(&mut self, rhs: i32)

Perform a checked multiplication, panicking on overflow.

impl Ord for Duration

fn cmp(&self, other: &Duration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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: &Rhs) -> bool

This method 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

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

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

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

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

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

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

fn sub(self, rhs: Duration) -> <Duration as Sub<Duration>>::Output

Perform a checked subtraction, panicking on overflow.

type Output = Duration

The resulting type after applying the - operator.

impl Sub<Duration> for Time

fn sub(self, rhs: Duration) -> <Time as Sub<Duration>>::Output

Put back the time by duration and return the result.

type Output = Time

The resulting type after applying the - operator.

impl SubAssign<Duration> for Duration

fn sub_assign(&mut self, rhs: Duration)

Perform a checked subtraction, panicking on overflow.

impl SubAssign<Duration> for Time

fn sub_assign(&mut self, rhs: Duration)

Put back the time by duration in place.

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

fn sum<I>(iter: I) -> Durationwhere
    I: Iterator<Item = &'a Duration>,

Perform a checked summation, panicking on overflow.

impl Sum<Duration> for Duration

fn sum<I>(iter: I) -> Durationwhere
    I: Iterator<Item = Duration>,

Perform a checked summation, panicking on overflow.

impl TryFrom<Duration> for Duration

fn try_from(
    value: Duration
) -> Result<Duration, <Duration as TryFrom<Duration>>::Error>

Try to construct a Duration from the specified chrono_0p4::Duration. Returns an error if the specified Duration overflows the representable range of the destination type.

The sub-microsecond part is rounded by truncating.

Examples

use chrono_0p4::Duration as ChronoDuration;
use r3_core::time::Duration as OsDuration;
assert_eq!(
    OsDuration::try_from(ChronoDuration::nanoseconds(123_456)),
    Ok(OsDuration::from_micros(123)),
);
assert_eq!(
    OsDuration::try_from(ChronoDuration::nanoseconds(-123_456)),
    Ok(OsDuration::from_micros(-123)),
);
assert!(
    OsDuration::try_from(ChronoDuration::microseconds(0x100000000))
        .is_err()
);

type Error = TryFromDurationError

The type returned in the event of a conversion error.

impl TryFrom<Duration> for Duration

fn try_from(
    value: Duration
) -> Result<Duration, <Duration as TryFrom<Duration>>::Error>

Try to construct a Duration from the specified core::time::Duration. Returns an error if the specified Duration overflows the representable range of the destination type.

The sub-microsecond part is rounded by truncating.

type Error = TryFromDurationError

The type returned in the event of a conversion error.

impl Copy for Duration

impl Eq for Duration

impl StructuralEq for Duration

impl StructuralPartialEq for Duration

impl ZeroInit for Duration