Skip to main content

UltraFastEncoderOptions

Struct UltraFastEncoderOptions 

Source
pub struct UltraFastEncoderOptions {
    pub invert_direction: bool,
    pub signal_mode_direction_clock: bool,
    pub enable_4x_sampling: bool,
}
Expand description

Ultra-fast encoder options (protocol command 0x1C byte 4 = “additional options”).

Bit layout matches PoKeysLib C reference (ePK_UltraFastEncoderOptions):

BitMaskMeaning
00x01Invert direction.
10x02Signal mode: false = quadrature (A/B), true = direction + clock.
20x04Enable 4x sampling.

Bits 3-7 are reserved.

Fields§

§invert_direction: bool

Invert direction (bit 0).

§signal_mode_direction_clock: bool

Signal mode. false = A/B are quadrature inputs; true = A is the direction signal and B is the clock signal.

§enable_4x_sampling: bool

Enable 4x sampling (both edges of A and B counted).

Implementations§

Source§

impl UltraFastEncoderOptions

Source

pub fn to_byte(self) -> u8

Pack into the options byte sent to the device.

Source

pub fn from_byte(byte: u8) -> Self

Decode from a device-reported options byte.

Trait Implementations§

Source§

impl Clone for UltraFastEncoderOptions

Source§

fn clone(&self) -> UltraFastEncoderOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UltraFastEncoderOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UltraFastEncoderOptions

Source§

fn default() -> UltraFastEncoderOptions

Returns the “default value” for a type. Read more
Source§

impl PartialEq for UltraFastEncoderOptions

Source§

fn eq(&self, other: &UltraFastEncoderOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for UltraFastEncoderOptions

Source§

impl Eq for UltraFastEncoderOptions

Source§

impl StructuralPartialEq for UltraFastEncoderOptions

Auto Trait Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.