Struct embedded_timers::Timer

pub struct Timer<'a, CLOCK>
where
    CLOCK: Clock,
{ /* private fields */ }

An instance of a timer tied to a specific Clock and Timing Duration type.

Implementations

impl<'a, CLOCK> Timer<'a, CLOCK>

where CLOCK: Clock,

pub fn new(clock: &'a CLOCK) -> Self

Create a new Timer tied to a specific clock

pub fn duration(&self) -> Result<Duration, TimerError>

Get the Duration of the current timer, or Err if it is not running

pub fn is_running(&self) -> Result<bool, TimerError>

If the timer is running, this is true. If not, it is false. It can also return an error from the Clock.

pub fn is_expired(&self) -> Result<bool, TimerError>

If the timer is expired, this is true. If not, it is false. It can also return an error from the Clock.

pub fn duration_left(&self) -> Result<Duration, TimerError>

Get the Duration until expire of the current timer, or Err if it is not running or if “now” could not be calculated

pub fn try_start(&mut self, duration: Duration) -> Result<(), TimerError>

Try to start the timer. Can fail due to errors from the clock.

pub fn try_wait(&mut self) -> Result<(), TimerError>

Try to wait for the timer, return an error if it is not running.

Trait Implementations

impl<'a, CLOCK> Cancel for Timer<'a, CLOCK>

where CLOCK: Clock,

type Error = TimerError

Error returned when a countdown can’t be canceled.

fn cancel(&mut self) -> Result<(), Self::Error>

Tries to cancel this countdown.

impl<'a, CLOCK> Debug for Timer<'a, CLOCK>

where CLOCK: Clock + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, CLOCK> CountDown for Timer<'a, CLOCK>

where CLOCK: Clock,

type Time = Duration

The unit of time used by this timer

fn start<T: Into<Self::Time>>(&mut self, duration: T)

Starts a new count down

fn wait(&mut self) -> Result<(), Void>

Non-blockingly “waits” until the count down finishes