[][src]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.


impl Timer[src]

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

Create a new timer builder.

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

Start the timer.

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

Stop the timer.

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

Change the period of the timer.

pub unsafe fn detach(self)[src]

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 Drop for Timer[src]

impl Send for Timer[src]

impl Sync for Timer[src]

Blanket Implementations

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

type Error = Infallible

The type returned in the event of a conversion error.

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

impl<T> From<T> for T[src]

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.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized