[−][src]Struct r3::kernel::cfg::CfgTimerBuilder

#[must_use = "must call `finish()` to complete registration"]pub struct CfgTimerBuilder<System> { /* fields omitted */ }

Configuration builder type for Timer.

Implementations

impl<System: Port> CfgTimerBuilder<System>[src]

pub const fn start(self, start: fn(_: usize)) -> Self[src]

[Required] Specify the timer's entry point. It will be called in an interrupt context.

pub const fn param(self, param: usize) -> Self[src]

Specify the parameter to start. Defaults to 0.

pub const fn active(self, active: bool) -> Self[src]

Specify whether the timer should be started at system startup. Defaults to false (don't activate).

pub const fn delay(self, delay: Duration) -> Self[src]

Specify the initial delay. Defaults to None (infinity; the timer will never fire).

pub const fn period(self, period: Duration) -> Self[src]

Specify the initial period. Defaults to None (infinity; the timer will stop firing after the next tick).

pub const fn finish(self, cfg: &mut CfgBuilder<System>) -> Timer<System>[src]

Complete the definition of a timer, returning a reference to the timer.

Auto Trait Implementations

impl<System> Send for CfgTimerBuilder<System> where
    System: Send, [src]

impl<System> Sync for CfgTimerBuilder<System> where
    System: Sync, [src]

impl<System> Unpin for CfgTimerBuilder<System> where
    System: Unpin, [src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

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

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.