Skip to main content

Runner

Struct Runner 

Source
pub struct Runner<'a, C = MonotonicCurveLut256>
where C: MonotonicCurve<u8, u8> + Copy,
{ /* private fields */ }
Expand description

Executes a Program against an ERM or LRA motor configuration.

The caller supplies a free-running wrapping u32 millisecond clock to Runner::poll and applies the returned DriveCommand. Polling may then pause until Frame::next_transition_ms; fixed-rate polling is unnecessary.

Implementations§

Source§

impl<'a, C> Runner<'a, C>
where C: MonotonicCurve<u8, u8> + Copy,

Source

pub fn start(&mut self, now_ms: u32)

Start playback at now_ms.

Source

pub fn restart(&mut self, now_ms: u32)

Restart playback from the beginning at now_ms.

Source

pub fn start_and_poll(&mut self, now_ms: u32) -> Frame

Start playback at now_ms and return the first frame.

Source

pub fn poll_or_start(&mut self, now_ms: u32) -> Frame

Poll current output; if not running, start playback at now_ms first.

Source

pub fn stop(&mut self)

Stop playback.

Source

pub const fn is_running(&self) -> bool

Whether the program is currently running.

Source

pub const fn motor(&self) -> MotorConfig

Motor configuration assigned to this runner.

Source

pub const fn start_ms(&self) -> u32

Current start timestamp used as cycle origin.

Source

pub fn poll(&mut self, now_ms: u32) -> Frame

Evaluate output for the wrapping millisecond clock value now_ms.

The returned frame’s deadline is the earliest time the command may change. Callers should wait with wrapping arithmetic and poll again at that deadline. If the deadline equals now_ms, poll again immediately to drain the control-flow transition. Completion is edge-triggered; see Frame::finished.

Trait Implementations§

Source§

impl<'a, C> Debug for Runner<'a, C>
where C: MonotonicCurve<u8, u8> + Copy + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, C> Freeze for Runner<'a, C>

§

impl<'a, C> RefUnwindSafe for Runner<'a, C>
where C: RefUnwindSafe,

§

impl<'a, C> Send for Runner<'a, C>
where C: Sync,

§

impl<'a, C> Sync for Runner<'a, C>
where C: Sync,

§

impl<'a, C> Unpin for Runner<'a, C>

§

impl<'a, C> UnsafeUnpin for Runner<'a, C>

§

impl<'a, C> UnwindSafe for Runner<'a, C>
where C: RefUnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_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.