Struct drv8825::MoveToFuture
source · [−]pub struct MoveToFuture<Driver> where
Driver: MotionControl, { /* private fields */ }
Expand description
The “future” returned by Stepper::move_to_position
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
sourceimpl<Driver> MoveToFuture<Driver> where
Driver: MotionControl,
impl<Driver> MoveToFuture<Driver> where
Driver: MotionControl,
sourcepub fn new(
driver: Driver,
max_velocity: <Driver as MotionControl>::Velocity,
target_step: i32
) -> MoveToFuture<Driver>
pub fn new(
driver: Driver,
max_velocity: <Driver as MotionControl>::Velocity,
target_step: i32
) -> MoveToFuture<Driver>
Create new instance of MoveToFuture
This constructor is public to provide maximum flexibility for
non-standard use cases. Most users can ignore this and just use
Stepper::move_to_position
instead.
sourcepub fn poll(&mut self) -> Poll<Result<(), <Driver as MotionControl>::Error>>
pub fn poll(&mut self) -> Poll<Result<(), <Driver as MotionControl>::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.
sourcepub fn wait(&mut self) -> Result<(), <Driver as MotionControl>::Error>
pub fn wait(&mut self) -> Result<(), <Driver as MotionControl>::Error>
Wait until the operation completes
This method will call Self::poll
in a busy loop until the operation
has finished.
Auto Trait Implementations
impl<Driver> RefUnwindSafe for MoveToFuture<Driver> where
Driver: RefUnwindSafe,
<Driver as MotionControl>::Velocity: RefUnwindSafe,
impl<Driver> Send for MoveToFuture<Driver> where
Driver: Send,
<Driver as MotionControl>::Velocity: Send,
impl<Driver> Sync for MoveToFuture<Driver> where
Driver: Sync,
<Driver as MotionControl>::Velocity: Sync,
impl<Driver> Unpin for MoveToFuture<Driver> where
Driver: Unpin,
<Driver as MotionControl>::Velocity: Unpin,
impl<Driver> UnwindSafe for MoveToFuture<Driver> where
Driver: UnwindSafe,
<Driver as MotionControl>::Velocity: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedAs for T
impl<T> CheckedAs for T
sourcefn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
sourcefn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
sourceimpl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
sourcefn lossless_try_into(self) -> Option<Dst>
fn lossless_try_into(self) -> Option<Dst>
Performs the conversion.
sourceimpl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
sourcefn lossy_into(self) -> Dst
fn lossy_into(self) -> Dst
Performs the conversion.
sourceimpl<T> OverflowingAs for T
impl<T> OverflowingAs for T
sourcefn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
sourcefn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
sourceimpl<T> SaturatingAs for T
impl<T> SaturatingAs for T
sourcefn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
sourcefn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
sourcefn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
sourcefn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> WrappingAs for T
impl<T> WrappingAs for T
sourcefn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
sourcefn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.