Struct Key

Source
pub struct Key<R: Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> {
    pub chords: Slice<(ChordId, R), MAX_OVERLAPPING_CHORD_SIZE>,
    pub passthrough: R,
    /* private fields */
}
Expand description

Primary Chorded key (with a passthrough key).

The primary key is the key with the lowest index in the chord, and has the key used for the resolved chord.

Fields§

§chords: Slice<(ChordId, R), MAX_OVERLAPPING_CHORD_SIZE>

The chorded key

§passthrough: R

The passthrough key

Implementations§

Source§

impl<R: Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Source

pub fn new_pressed_key( &self, context: &Context<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>, keymap_index: u16, ) -> (PressedKeyResult<R, PendingKeyState<MAX_CHORDS, MAX_CHORD_SIZE, MAX_PRESSED_INDICES>, KeyState>, KeyEvents<Event>)

Constructs new pressed key.

Source

pub const fn new(chords: &[(ChordId, R)], passthrough: R) -> Self

Constructs new chorded key.

Trait Implementations§

Source§

impl<R: Clone + Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Clone for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Source§

fn clone( &self, ) -> Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

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<R: Debug + Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Debug for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Source§

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

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

impl<'de, R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Deserialize<'de> for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: Deserialize<'de> + Copy,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<R: PartialEq + Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> PartialEq for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Source§

fn eq( &self, other: &Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>, ) -> 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<R: Copy + Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Copy for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Source§

impl<R: Copy, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> StructuralPartialEq for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>

Auto Trait Implementations§

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Freeze for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: Freeze,

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> RefUnwindSafe for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: RefUnwindSafe,

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Send for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: Send,

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Sync for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: Sync,

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> Unpin for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: Unpin,

§

impl<R, const MAX_CHORDS: usize, const MAX_CHORD_SIZE: usize, const MAX_OVERLAPPING_CHORD_SIZE: usize, const MAX_PRESSED_INDICES: usize> UnwindSafe for Key<R, MAX_CHORDS, MAX_CHORD_SIZE, MAX_OVERLAPPING_CHORD_SIZE, MAX_PRESSED_INDICES>
where R: UnwindSafe,

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<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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,