Embassy
embassy-time

Crates

git

Versions

default

Flavors

Struct embassy_time::Duration

source ·
pub struct Duration { /* private fields */ }
Expand description

Represents the difference between two Instants

Implementations§

source§

impl Duration

source

pub const MIN: Duration = _

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

source

pub const MAX: Duration = _

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

source

pub const fn as_ticks(&self) -> u64

Tick count of the Duration.

source

pub const fn as_secs(&self) -> u64

Convert the Duration to seconds, rounding down.

source

pub const fn as_millis(&self) -> u64

Convert the Duration to milliseconds, rounding down.

source

pub const fn as_micros(&self) -> u64

Convert the Duration to microseconds, rounding down.

source

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

Creates a duration from the specified number of clock ticks

source

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

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

source

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

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

source

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.

source

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.

source

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

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

source

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

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

source

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.

source

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.

source

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.

source

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.

source

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.

source

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§

source§

impl Add<Duration> for Instant

§

type Output = Instant

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl Add for Duration

§

type Output = Duration

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<Duration> for Instant

source§

fn add_assign(&mut self, other: Duration)

Performs the += operation. Read more
source§

impl AddAssign for Duration

source§

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more
source§

impl Clone for Duration

source§

fn clone(&self) -> Duration

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Duration

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Duration

source§

fn default() -> Duration

Returns the “default value” for a type. Read more
source§

impl<'a> Display for Duration

source§

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

Formats the value using the given formatter. Read more
source§

impl Div<u32> for Duration

§

type Output = Duration

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl DivAssign<u32> for Duration

source§

fn div_assign(&mut self, rhs: u32)

Performs the /= operation. Read more
source§

impl Format for Duration

source§

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

Writes the defmt representation of self to fmt.
source§

impl From<Duration> for Duration

source§

fn from(value: Duration) -> Self

Converts using Duration::as_micros.

source§

impl Mul<Duration> for u32

§

type Output = Duration

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<u32> for Duration

§

type Output = Duration

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<u32> for Duration

source§

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation. Read more
source§

impl Ord for Duration

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Duration

source§

fn eq(&self, other: &Duration) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd for Duration

source§

fn partial_cmp(&self, other: &Duration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Sub<Duration> for Instant

§

type Output = Instant

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub for Duration

§

type Output = Duration

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<Duration> for Instant

source§

fn sub_assign(&mut self, other: Duration)

Performs the -= operation. Read more
source§

impl SubAssign for Duration

source§

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more
source§

impl TryFrom<Duration> for Duration

source§

fn try_from(value: Duration) -> Result<Self, Self::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.
source§

impl Copy for Duration

source§

impl Eq for Duration

source§

impl StructuralEq for Duration

source§

impl StructuralPartialEq for Duration

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.