Skip to main content

FastEncoderOptions

Struct FastEncoderOptions 

Source
pub struct FastEncoderOptions {
    pub disable_4x_sampling: bool,
    pub invert_direction_1: bool,
    pub invert_direction_2: bool,
    pub invert_direction_3: bool,
}
Expand description

Per-encoder options for the fast encoders (protocol command 0xCE byte 4 = “FastEncodersOptions”).

Bit layout matches the PoKeysLib C reference (ePK_FastEncoderOptions):

BitMaskMeaning
40x10Disable 4x sampling (default is 4x on).
50x20Invert direction of fast encoder 1.
60x40Invert direction of fast encoder 2.
70x80Invert direction of fast encoder 3.

Bits 0-3 are reserved (the low nibble carries nothing — the configuration selector lives in a separate byte, see FastEncoderConfiguration).

Fields§

§disable_4x_sampling: bool

Disable 4x sampling for the fast encoders (default is 4x enabled).

§invert_direction_1: bool

Invert direction of fast encoder 1.

§invert_direction_2: bool

Invert direction of fast encoder 2.

§invert_direction_3: bool

Invert direction of fast encoder 3.

Implementations§

Source§

impl FastEncoderOptions

Source

pub fn to_byte(self) -> u8

Pack the options into the protocol byte (byte 4 of command 0xCE).

Source

pub fn from_byte(byte: u8) -> Self

Decode an options byte back into the struct (reserved bits ignored).

Trait Implementations§

Source§

impl Clone for FastEncoderOptions

Source§

fn clone(&self) -> FastEncoderOptions

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 FastEncoderOptions

Source§

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

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

impl Default for FastEncoderOptions

Source§

fn default() -> FastEncoderOptions

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

impl PartialEq for FastEncoderOptions

Source§

fn eq(&self, other: &FastEncoderOptions) -> 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 FastEncoderOptions

Source§

impl Eq for FastEncoderOptions

Source§

impl StructuralPartialEq for FastEncoderOptions

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.