Struct freertos_rs::Timer

pub struct Timer { /* fields omitted */ }

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.

Methods

impl Timer

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

Create a new timer builder.

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

Start the timer.

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

Stop the timer.

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

Change the period of the timer.

unsafe 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.

Trait Implementations

impl Send for Timer

impl Sync for Timer

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.