Enum KeyAction 

pub enum KeyAction {
    No,
    Transparent,
    Single(Action),
    Tap(Action),
    TapHold(Action, Action, MorseProfile),
    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

No

No action. Serialized as 0x0000.

Transparent

Transparent action, next layer will be checked. Serialized as 0x0001.

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, MorseProfile)

Tap hold action

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 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 MaxSize for KeyAction

const POSTCARD_MAX_SIZE: usize = 14usize

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

impl PartialEq for KeyAction

combo, fork, etc. compares key actions WARNING: this is not a perfect comparison, we ignores the profile config of TapHold!

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Copy for KeyAction

impl Eq for KeyAction