Skip to main content

EncoderOptions

Struct EncoderOptions 

Source
pub struct EncoderOptions {
    pub enabled: bool,
    pub sampling_4x: bool,
    pub sampling_2x: bool,
    pub direct_key_mapping_a: bool,
    pub macro_mapping_a: bool,
    pub direct_key_mapping_b: bool,
    pub macro_mapping_b: bool,
}
Expand description

Encoder configuration options

Fields§

§enabled: bool

Enable encoder

§sampling_4x: bool

4x sampling mode (both A and B edges counted)

§sampling_2x: bool

2x sampling mode (only A edges counted)

§direct_key_mapping_a: bool

Direct key mapping for direction A

§macro_mapping_a: bool

Macro mapping for direction A

§direct_key_mapping_b: bool

Direct key mapping for direction B

§macro_mapping_b: bool

Macro mapping for direction B

Implementations§

Source§

impl EncoderOptions

Source

pub fn new() -> Self

Create new encoder options with all features disabled

Source

pub fn with_4x_sampling() -> Self

Create encoder options with 4x sampling enabled

Source

pub fn with_2x_sampling() -> Self

Create encoder options with 2x sampling enabled

Source

pub fn to_byte(&self) -> u8

Convert options to protocol byte format Bit layout: [macro_b][key_b][macro_a][key_a][reserved][2x][4x][enable]

Source

pub fn from_byte(byte: u8) -> Self

Create options from protocol byte format

Trait Implementations§

Source§

impl Clone for EncoderOptions

Source§

fn clone(&self) -> EncoderOptions

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 EncoderOptions

Source§

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

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

impl Default for EncoderOptions

Source§

fn default() -> Self

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

impl PartialEq for EncoderOptions

Source§

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

Source§

impl Eq for EncoderOptions

Source§

impl StructuralPartialEq for EncoderOptions

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.