Struct SetStepModeFuture

Source
pub struct SetStepModeFuture<Driver, Timer, const TIMER_HZ: u32>
where Driver: SetStepMode,
{ /* private fields */ }
Expand description

The “future” returned by Stepper::set_step_mode

Please note that this type provides a custom API and does not implement core::future::Future. This might change, when using futures for embedded development becomes more practical.

Implementations§

Source§

impl<Driver, Timer, const TIMER_HZ: u32> SetStepModeFuture<Driver, Timer, TIMER_HZ>
where Driver: SetStepMode, Timer: Timer<TIMER_HZ>,

Source

pub fn new( step_mode: <Driver as SetStepMode>::StepMode, driver: Driver, timer: Timer, ) -> SetStepModeFuture<Driver, Timer, TIMER_HZ>

Create new instance of SetStepModeFuture

This constructor is public to provide maximum flexibility for non-standard use cases. Most users can ignore this and just use Stepper::set_step_mode instead.

Source

pub fn poll( &mut self, ) -> Poll<Result<(), SignalError<Infallible, <Driver as SetStepMode>::Error, <Timer as Timer<TIMER_HZ>>::Error>>>

Poll the future

The future must be polled for the operation to make progress. The operation won’t start, until this method has been called once. Returns Poll::Pending, if the operation is not finished yet, or Poll::Ready, once it is.

If this method returns Poll::Pending, the user can opt to keep calling it at a high frequency (see Self::wait) until the operation completes, or set up an interrupt that fires once the timer finishes counting down, and call this method again once it does.

Source

pub fn wait( &mut self, ) -> Result<(), SignalError<Infallible, <Driver as SetStepMode>::Error, <Timer as Timer<TIMER_HZ>>::Error>>

Wait until the operation completes

This method will call Self::poll in a busy loop until the operation has finished.

Source

pub fn release(self) -> (Driver, Timer)

Drop the future and release the resources that were moved into it

Auto Trait Implementations§

§

impl<Driver, Timer, const TIMER_HZ: u32> Freeze for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: Freeze, Driver: Freeze, Timer: Freeze,

§

impl<Driver, Timer, const TIMER_HZ: u32> RefUnwindSafe for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: RefUnwindSafe, Driver: RefUnwindSafe, Timer: RefUnwindSafe,

§

impl<Driver, Timer, const TIMER_HZ: u32> Send for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: Send, Driver: Send, Timer: Send,

§

impl<Driver, Timer, const TIMER_HZ: u32> Sync for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: Sync, Driver: Sync, Timer: Sync,

§

impl<Driver, Timer, const TIMER_HZ: u32> Unpin for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: Unpin, Driver: Unpin, Timer: Unpin,

§

impl<Driver, Timer, const TIMER_HZ: u32> UnwindSafe for SetStepModeFuture<Driver, Timer, TIMER_HZ>
where <Driver as SetStepMode>::StepMode: UnwindSafe, Driver: UnwindSafe, Timer: UnwindSafe,

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

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>,

Source§

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

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.