Struct riot_wrappers::ztimer::Ticks

pub struct Ticks<const HZ: u32>(pub u32);

Available on riot_module_ztimer only.

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

impl<const HZ: u32> Ticks<HZ>

pub const MAX: Self = _

Maximum duration expressible on a clock with the given frequency

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Error = Overflow

The type returned in the event of a conversion error.

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

Performs the conversion.

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