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>
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>
pub const fn const_default() -> Self
pub fn get_keyaction( &self, layer: usize, row: usize, col: usize, ) -> Option<&KeyAction>
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>
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>
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto 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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more