Struct step_dir::SetDirectionFuture

pub struct SetDirectionFuture<'r, T, Timer> { /* fields omitted */ }

A "future" that can be polled to complete a Driver::set_direction call

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

Implementations

impl<'r, T, Timer> SetDirectionFuture<'r, T, Timer> where
    T: SetDirection,
    Timer: CountDown,
    Timer::Time: TryFrom<Nanoseconds>, 

pub fn poll(
    &mut self
) -> Poll<Result<(), Error<T::Error, <Timer::Time as TryFrom<Nanoseconds>>::Error, Timer::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.

pub fn wait(
    &mut self
) -> Result<(), Error<T::Error, <Timer::Time as TryFrom<Nanoseconds>>::Error, Timer::Error>>

Wait until the operation completes

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