pub struct Timer<H: Handler, const HZ: u32> { /* private fields */ }
Available on riot_module_ztimer and riot_module_ztimer_periodic only.
Expand description

A periodic timer

This periodic timer is built on a clock and configured with a frequency and tick handler.

It contains the handler and a ztimer_periodic_t C struct that then contains the actual timer as well as a reference to the clock. Being self-referential by nature, it is mainly used in pinned form. It can be started and stopped, and stops automatically when dropped.

Implementations§

source§

impl<H: Handler, const HZ: u32> Timer<H, HZ>

source

pub fn new(clock: Clock<HZ>, handler: H, ticks: Ticks<HZ>) -> Self

source

pub fn stop(&mut self)

source

pub fn alter<R, F: FnOnce(&mut H) -> R>(self: &mut Pin<&mut Self>, f: F) -> R

Obtain a mutable reference to the handler.

This can be used, for example, to feed data into a handler that is sent out whenever the timer triggers.

This is relatively invasive to the system as it creates a critical section (ie. possibly delaying the execution of the next timer, or even other interrupts). In many cases, the preferable way to send data to the timer is to use a lock-free data structure.

source§

impl<H: Handler + 'static, const HZ: u32> Timer<H, HZ>

source

pub fn start(self: &mut Pin<&mut Self>)

Start the timer, calling the handler at every interval.

This requires a Handler + 'static because it relies on the timer’s drop to stop the process, and only a static handler can still safely be called if that drop never happens.

(For non-static handlers, a scoped version might be introduced later).

Trait Implementations§

source§

impl<H: Handler, const HZ: u32> Drop for Timer<H, HZ>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<H, const HZ: u32> RefUnwindSafe for Timer<H, HZ>
where H: RefUnwindSafe,

§

impl<H, const HZ: u32> !Send for Timer<H, HZ>

§

impl<H, const HZ: u32> !Sync for Timer<H, HZ>

§

impl<H, const HZ: u32> !Unpin for Timer<H, HZ>

§

impl<H, const HZ: u32> UnwindSafe for Timer<H, HZ>
where H: UnwindSafe,

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> 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> Same for T

§

type Output = T

Should always be Self
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.