Enum KeyAction 

#[non_exhaustive]
pub enum KeyAction {
    No,
    Transparent,
    Single(Action),
    Tap(Action),
    TapHold(Action, Action, u8),
    Morse(u8),
}

A KeyAction is the action at a keyboard position, stored in keymap. It can be a single action like triggering a key, or a composite keyboard action like tap/hold

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

No

No action

Transparent

Transparent action, next layer will be checked

Single(Action)

A single action, such as triggering a key, or activating a layer. Action is triggered when pressed and cancelled when released.

Tap(Action)

Don’t wait the release of the key, auto-release after a time threshold.

TapHold(Action, Action, u8)

Tap hold action. The u8 indexes the morse profile table; an index with no table entry (e.g. u8::MAX, which the default-profile macros emit) falls back to the default crate::morse::MorseProfile.

Morse(u8)

Morse action, references a morse configuration by index.

Implementations

impl KeyAction

pub fn to_action(self) -> Action

Convert KeyAction to the internal Action. Only valid for Single and Tap variant, returns Action::No for other variants.

pub fn is_morse(&self) -> bool

‘morse’ is an alias for the superset of tap dance and tap hold keys, since their handling have many similarities

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for KeyAction

fn clone(&self) -> KeyAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyAction

impl Debug for KeyAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyAction

impl MaxSize for KeyAction

const POSTCARD_MAX_SIZE: usize

The maximum possible size that the serialization of this type can have, in bytes.

impl PartialEq for KeyAction

Combo and fork trigger matching compares key actions by their “identity” — the tap/hold actions — ignoring the profile-table index.

This is intentional: a combo or fork may store a trigger with one profile index, but if the user later rebinds the key’s profile, the trigger should still match. The profile is a per-key timing config, not part of the key’s logical identity.

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KeyAction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.