riot_wrappers::ztimer

Struct Ticks

Source
pub struct Ticks<const HZ: u32>(pub u32);
Available on riot_module_ztimer only.
Expand description

A duration on a clock of fixed speed

In memory, these are numbers of ticks. Semantically, these are durations of self.0 / HZ seconds.

Tuple Fields§

§0: u32

Implementations§

Source§

impl<const HZ: u32> Ticks<HZ>

Source

pub const MAX: Self = _

Maximum duration expressible on a clock with the given frequency

Source

pub const fn from_duration(duration: Duration) -> Result<Self, Overflow>

Fallible conversion from a Duration

This is an extra function (equivalently available as try_from) as it allows the result to be const (which many constructed durations are).

Conversion is not perfect if HZ does not a divisor of $10^9$.

This will be deprecated when TryFrom / TryInto can be optionally const (see https://github.com/rust-lang/rust/issues/67792 for efforts).

Trait Implementations§

Source§

impl<const HZ: u32> Clone for Ticks<HZ>

Source§

fn clone(&self) -> Ticks<HZ>

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<const HZ: u32> Debug for Ticks<HZ>

Source§

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

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

impl<const HZ: u32> TryFrom<Duration> for Ticks<HZ>

Source§

type Error = Overflow

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

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

Performs the conversion.
Source§

impl<const HZ: u32> Copy for Ticks<HZ>

Auto Trait Implementations§

§

impl<const HZ: u32> Freeze for Ticks<HZ>

§

impl<const HZ: u32> RefUnwindSafe for Ticks<HZ>

§

impl<const HZ: u32> Send for Ticks<HZ>

§

impl<const HZ: u32> Sync for Ticks<HZ>

§

impl<const HZ: u32> Unpin for Ticks<HZ>

§

impl<const HZ: u32> UnwindSafe for Ticks<HZ>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> IntoSwitch for T

Source§

fn into_switch<ActiveLevel>(self) -> Switch<T, ActiveLevel>

Consumes the IoPin returning a Switch of the appropriate ActiveLevel. Read more
Source§

fn into_active_low_switch(self) -> Switch<Self, ActiveLow>
where Self: Sized,

Consumes the IoPin returning a Switch<IoPin, ActiveLow>. Read more
Source§

fn into_active_high_switch(self) -> Switch<Self, ActiveHigh>
where Self: Sized,

Consumes the IoPin returning a Switch<IoPin, ActiveHigh>. Read more
Source§

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

Source§

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>,

Source§

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.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes