Struct rp2040_hal::timer::CountDown

source ·
pub struct CountDown<'timer> { /* private fields */ }
Expand description

Implementation of the embedded_hal_0_2::timer traits using rp2040_hal::timer counter.

There is no Embedded HAL 1.0 equivalent at this time.

If all you need is a delay, Timer does implement embedded_hal::delay::DelayNs.

§Usage

use embedded_hal_0_2::timer::{CountDown, Cancel};
use fugit::ExtU32;
use rp2040_hal;
let mut pac = rp2040_hal::pac::Peripherals::take().unwrap();
// Make sure to initialize clocks, otherwise the timer wouldn't work
// properly. Omitted here for terseness.
let clocks: rp2040_hal::clocks::ClocksManager = todo!();
// Configure the Timer peripheral in count-down mode
let timer = rp2040_hal::Timer::new(pac.TIMER, &mut pac.RESETS, &clocks);
let mut count_down = timer.count_down();
// Create a count_down timer for 500 milliseconds
count_down.start(500.millis());
// Block until timer has elapsed
let _ = nb::block!(count_down.wait());
// Restart the count_down timer with a period of 100 milliseconds
count_down.start(100.millis());
// Cancel it immediately
count_down.cancel();

Trait Implementations§

source§

impl Cancel for CountDown<'_>

§

type Error = &'static str

Error returned when a countdown can’t be canceled.
source§

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

Tries to cancel this countdown. Read more
source§

impl CountDown for CountDown<'_>

§

type Time = Duration<u64, 1, 1000000>

The unit of time used by this timer
source§

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

Starts a new count down
source§

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

Non-blockingly “waits” until the count down finishes Read more
source§

impl Periodic for CountDown<'_>

Auto Trait Implementations§

§

impl<'timer> RefUnwindSafe for CountDown<'timer>

§

impl<'timer> Send for CountDown<'timer>

§

impl<'timer> Sync for CountDown<'timer>

§

impl<'timer> Unpin for CountDown<'timer>

§

impl<'timer> UnwindSafe for CountDown<'timer>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Choices> CoproductSubsetter<CNil, HNil> for Choices

§

type Remainder = Choices

source§

fn subset( self ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

source§

fn lift_into(self) -> U

Performs the indexed conversion.
source§

impl<Source> Sculptor<HNil, HNil> for Source

§

type Remainder = Source

source§

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.