Enum Action 

#[non_exhaustive]
pub enum Action {
    No,
    Key(KeyCode),
    Modifier(ModifierCombination),
    KeyWithModifier(HidKeyCode, ModifierCombination),
    LayerOn(u8),
    LayerOnWithModifier(u8, ModifierCombination),
    LayerOff(u8),
    LayerToggle(u8),
    DefaultLayer(u8),
    LayerToggleOnly(u8),
    TriLayerLower,
    TriLayerUpper,
    TriggerMacro(u8),
    OneShotLayer(u8),
    OneShotModifier(ModifierCombination),
    OneShotKey(HidKeyCode),
    Light(LightAction),
    KeyboardControl(KeyboardAction),
    Special(SpecialKey),
    User(u8),
    PersistentDefaultLayer(u8),
}

A single basic action that a keyboard can execute.

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

Default action, no action.

Key(KeyCode)

A normal key stroke, uses for all keycodes defined in KeyCode enum, including mouse key, consumer/system control, etc.

Modifier(ModifierCombination)

Modifier Combination, used in tap hold

KeyWithModifier(HidKeyCode, ModifierCombination)

Key stroke with modifier combination triggered. Modifiers only apply to HID keyboard keys, so this carries a HidKeyCode rather than a full KeyCode.

LayerOn(u8)

Activate a layer

LayerOnWithModifier(u8, ModifierCombination)

Activate a layer with modifier combination triggered.

LayerOff(u8)

Deactivate a layer

LayerToggle(u8)

Toggle a layer

DefaultLayer(u8)

Set default layer

LayerToggleOnly(u8)

Activate a layer and deactivate all other layers(except default layer)

TriLayerLower

TriLayerUpper

TriggerMacro(u8)

Triggers the Macro at the ‘index’.

OneShotLayer(u8)

Oneshot layer, keep the layer active until the next key is triggered.

OneShotModifier(ModifierCombination)

Oneshot modifier, keep the modifier active until the next key is triggered.

OneShotKey(HidKeyCode)

Oneshot key, keep the key active until the next key is triggered.

Light(LightAction)

Actions for controlling lights

KeyboardControl(KeyboardAction)

Actions for controlling the keyboard

Special(SpecialKey)

Special Keys

User(u8)

User Keys

PersistentDefaultLayer(u8)

Set the default layer and persist it to storage; restored on next boot.

Runtime behavior matches Action::DefaultLayer; additionally persisted to flash.

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Action

impl Debug for Action

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Action

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Action

impl MaxSize for Action

const POSTCARD_MAX_SIZE: usize

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

impl PartialEq for Action

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Action

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Action