RKTK API Docs RKTK Home Repo

Struct Keymap

Source
pub struct Keymap<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> {
    pub layers: [Layer<ROW, COL, ENCODER_COUNT>; LAYER],
    pub tap_dance: TapDanceDefinitions<TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS>,
    pub combo: ComboDefinitions<COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>,
}
Expand description

Root keymap type

This structure holds all information about keymap.

Fields§

§layers: [Layer<ROW, COL, ENCODER_COUNT>; LAYER]§tap_dance: TapDanceDefinitions<TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS>§combo: ComboDefinitions<COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

Implementations§

Source§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

Source

pub const fn const_default() -> Self

Source

pub fn get_keyaction( &self, layer: usize, row: usize, col: usize, ) -> Option<&KeyAction>

Source

pub fn get_encoder_key( &self, layer_state: [bool; LAYER], encoder: usize, direction: EncoderDirection, ) -> Option<&KeyCode>

Trait Implementations§

Source§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Clone for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

Source§

fn clone( &self, ) -> Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

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

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Freeze for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> RefUnwindSafe for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Send for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Sync for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> Unpin for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

§

impl<const LAYER: usize, const ROW: usize, const COL: usize, const ENCODER_COUNT: usize, const TAP_DANCE_MAX_DEFINITIONS: usize, const TAP_DANCE_MAX_REPEATS: usize, const COMBO_KEY_MAX_DEFINITIONS: usize, const COMBO_KEY_MAX_SOURCES: usize> UnwindSafe for Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.