Struct rttrust::timer::Timer

pub struct Timer { /* fields omitted */ }

All methods use immutable self since the safety is guaranteed by rt-thread internal

TODO: timer control

Implementations

impl Timer

pub fn new(timer: &mut rt_timer) -> &Timer

pub fn create<P>(
    name: &str,
    entry: TimerEntry<P>,
    parameter: CallbackParameter,
    time: u32,
    flag: TimerFlags
) -> Result<Timer> where
    P: Into<CallbackParameter>, 

This function will create a timer

@param name the name of timer @param timeout the timeout function @param parameter the parameter of timeout function @param time the tick of timer @param flag the flag of timer

@return the created timer object

pub fn create_closure<F>(
    name: &str,
    entry: F,
    time: u32,
    flag: TimerFlags
) -> Result<Timer> where
    F: FnOnce(),
    F: Send + 'static, 

pub fn start(&self) -> Result<()>

This function will start the timer

@return the operation status, RT_EOK on OK, -RT_ERROR on error

pub fn delete(self) -> Result<()>

This function will delete a timer and release timer memory

@return the operation status, RT_EOK on OK; RT_ERROR on error

Wanring:

Rust timer has no cleanup function and is not able to unwind. Directly stopping a Rust timer may lead to resoucre leak.

pub fn stop(&self) -> Result<()>

This function will stop the timer

@return the operation status, RT_EOK on OK, -RT_ERROR on error

Wanring:

Rust timer has no cleanup function and is not able to unwind. Directly stopping a Rust timer may lead to resoucre leak.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Timer

impl Object for Timer

fn get_ptr(&self) -> NonNull<rt_object>

fn is_systemobject(&self) -> bool

fn get_type(&self) -> u8

fn get_name<'a>(&'a self) -> RtNameRef<'a>

impl Send for Timer