Struct Duration

pub struct Duration { /* private fields */ }

Available on crate feature time only.

Represents the difference between two Instants

Implementations

impl Duration

pub const MIN: Duration = _

The smallest value that can be represented by the Duration type.

pub const MAX: Duration = _

The largest value that can be represented by the Duration type.

pub const fn as_ticks(&self) -> u64

Tick count of the Duration.

pub const fn as_secs(&self) -> u64

Convert the Duration to seconds, rounding down.

pub const fn as_millis(&self) -> u64

Convert the Duration to milliseconds, rounding down.

pub const fn as_micros(&self) -> u64

Convert the Duration to microseconds, rounding down.

pub const fn from_ticks(ticks: u64) -> Duration

Creates a duration from the specified number of clock ticks

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

Creates a duration from the specified number of seconds, rounding up.

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

Creates a duration from the specified number of milliseconds, rounding up.

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

Creates a duration from the specified number of microseconds, rounding up. NOTE: Delays this small may be inaccurate.

pub const fn from_nanos(micros: u64) -> Duration

Creates a duration from the specified number of nanoseconds, rounding up. NOTE: Delays this small may be inaccurate.

pub const fn from_secs_floor(secs: u64) -> Duration

Creates a duration from the specified number of seconds, rounding down.

pub const fn from_millis_floor(millis: u64) -> Duration

Creates a duration from the specified number of milliseconds, rounding down.

pub const fn from_micros_floor(micros: u64) -> Duration

Creates a duration from the specified number of microseconds, rounding down. NOTE: Delays this small may be inaccurate.

pub const fn from_hz(hz: u64) -> Duration

Creates a duration corresponding to the specified Hz. NOTE: Giving this function a hz >= the TICK_HZ of your platform will clamp the Duration to 1 tick. Doing so will not deadlock, but will certainly not produce the desired output.

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

Adds one Duration to another, returning a new Duration or None in the event of an overflow.

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

Subtracts one Duration to another, returning a new Duration or None in the event of an overflow.

pub fn checked_mul(self, rhs: u32) -> Option<Duration>

Multiplies one Duration by a scalar u32, returning a new Duration or None in the event of an overflow.

pub fn checked_div(self, rhs: u32) -> Option<Duration>

Divides one Duration a scalar u32, returning a new Duration or None in the event of an overflow.

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, other: Duration) -> Instant

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 AddAssign<Duration> for Instant

fn add_assign(&mut self, other: 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 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<'a> Display for Duration

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

Formats the value using the given formatter.

impl Div<u32> for Duration

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u32> for Duration

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Format for Duration

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Mul<u32> for Duration

type Output = Duration

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u32> for Duration

fn mul_assign(&mut self, rhs: u32)

Performs the *= 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 Sub<Duration> for Instant

type Output = Instant

The resulting type after applying the - operator.

fn sub(self, other: Duration) -> Instant

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 SubAssign<Duration> for Instant

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl SubAssign for Duration

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl TryFrom<Duration> for Duration

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

Converts using Duration::from_micros. Fails if value can not be represented as u64.

type Error = <u64 as TryFrom<u128>>::Error

The type returned in the event of a conversion error.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration