Struct Rotary

pub struct Rotary<A, B, P> { /* private fields */ }

Holds current/old state and both InputPin

Implementations

impl<A, B> Rotary<A, B, DefaultPhase>

where A: InputPin, B: InputPin,

pub fn new(pin_a: A, pin_b: B) -> Self

Accepts two InputPins, these will be read on every update()

impl<A, B, P: Phase> Rotary<A, B, P>

where A: InputPin, B: InputPin,

pub fn with_phase(pin_a: A, pin_b: B, phase: P) -> Self

Accepts two InputPins, these will be read on every update(), while using phase to determine the direction.

pub fn update(&mut self) -> Result<Direction, Either<A::Error, B::Error>>

Call update to evaluate the next state of the encoder, propagates errors from InputPin read

pub fn pin_a(&mut self) -> &mut A

Returns a reference to the first pin. Can be used to clear interrupt.

pub fn pin_b(&mut self) -> &mut B

Returns a reference to the second pin. Can be used to clear interrupt.

pub fn pins(&mut self) -> (&mut A, &mut B)

Returns a reference to both pins. Can be used to clear interrupt.

pub fn into_inner(self) -> (A, B)

Consumes this Rotary, returning the underlying pins A and B.

Trait Implementations

impl<A: Clone, B: Clone, P: Clone> Clone for Rotary<A, B, P>

fn clone(&self) -> Rotary<A, B, P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Debug, B: Debug, P: Debug> Debug for Rotary<A, B, P>

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

Formats the value using the given formatter.

impl<A: PartialEq, B: PartialEq, P: PartialEq> PartialEq for Rotary<A, B, P>

fn eq(&self, other: &Rotary<A, B, P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Eq, B: Eq, P: Eq> Eq for Rotary<A, B, P>

impl<A, B, P> StructuralPartialEq for Rotary<A, B, P>