Skip to main content
RKTK API Docs RKTK Home Repo

Keymap

rktk::config::keymap::keymanager::keymap

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: [Option<TapDanceDefinition<TAP_DANCE_MAX_REPEATS>>; TAP_DANCE_MAX_DEFINITIONS],
    pub combo: [Option<ComboDefinition<COMBO_KEY_MAX_SOURCES>>; COMBO_KEY_MAX_DEFINITIONS],
}
Expand description

Root keymap type

This structure holds all information about keymap.

Fields§

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

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() -> Keymap<LAYER, ROW, COL, ENCODER_COUNT, TAP_DANCE_MAX_DEFINITIONS, TAP_DANCE_MAX_REPEATS, COMBO_KEY_MAX_DEFINITIONS, COMBO_KEY_MAX_SOURCES>

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 duplicate of the value. Read more
1.0.0 (const: unstable) · 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> UnsafeUnpin 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> FromColor<T> for T

Source§

fn from_color(color: T) -> T

Converts from the source color type
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, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Converts into the target color type
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.