Skip to main content
RKTK API Docs RKTK Home Repo

KeyAction

Enum KeyAction 

Source
pub enum KeyAction {
    Inherit,
    Normal(KeyCode),
    Normal2(KeyCode, KeyCode),
    TapHold(KeyCode, KeyCode),
    OneShot(KeyCode),
    TapDance(u8),
}
Expand description

Represents key action.

Variants§

§

Inherit

Inherit key definition from parent layer.

§

Normal(KeyCode)

Normal key

§

Normal2(KeyCode, KeyCode)

Normal key with secondary key. These keys are sent together.

§

TapHold(KeyCode, KeyCode)

Tap-Hold key (tap, hold)

If key is pressed and released in KeyResolverConfig::tap_hold, tap key is sent. If key is pressed and held longer, hold key is sent. Also, kmsm emulates qmk’s HOLD_ON_OTHER_KEY_PRESS feature. If another key is pressed while holding this key, even before tap_threshold, hold key is sent.

§

OneShot(KeyCode)

One-shot key

After pressing this key, the key will be sent together with the next key press.

§

TapDance(u8)

Tap-dance (id)

Execute tap-dance with specified id. TapDance can be configured in KeyResolverConfig.

Implementations§

Source§

impl KeyAction

Source

pub const fn const_default() -> Self

Trait Implementations§

Source§

impl Clone for KeyAction

Source§

fn clone(&self) -> KeyAction

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

impl Copy for KeyAction

Source§

impl Debug for KeyAction

Source§

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

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

impl Default for KeyAction

Source§

fn default() -> Self

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

impl Eq for KeyAction

Source§

impl Format for KeyAction
where KeyCode: Format,

Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for KeyAction

Source§

fn eq(&self, other: &KeyAction) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KeyAction

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<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, 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.