Struct Timer 

pub struct Timer { /* private fields */ }

A FreeRTOS software timer.

Note that all operations on a timer are processed by a FreeRTOS internal task that receives messages in a queue. Every operation has an associated waiting time for that queue to get unblocked.

Implementations

impl Timer

pub fn new<D: DurationTicks>(period: D) -> TimerBuilder<D>

Create a new timer builder.

pub unsafe fn from_raw_handle(handle: FreeRtosTimerHandle) -> Self

Create a timer from a raw handle.

Safety

handle must be a valid FreeRTOS timer handle.

pub fn raw_handle(&self) -> FreeRtosTimerHandle

pub fn start<D: DurationTicks>( &self, block_time: D, ) -> Result<(), FreeRtosError>

Start the timer.

pub fn start_from_isr( &self, context: &mut InterruptContext, ) -> Result<(), FreeRtosError>

Start the timer from an interrupt.

pub fn stop<D: DurationTicks>(&self, block_time: D) -> Result<(), FreeRtosError>

Stop the timer.

pub fn change_period<D: DurationTicks>( &self, block_time: D, new_period: D, ) -> Result<(), FreeRtosError>

Change the period of the timer.

pub fn detach(self)

Detach this timer from Rust’s memory management. The timer will still be active and will consume the memory.

Can be used for timers that will never be changed and don’t need to stay in scope.

This method is safe because resource leak is safe in Rust.

Trait Implementations

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Timer

impl Sync for Timer