Struct Key 

pub struct Key<R> {
    pub tap: R,
    pub hold: R,
    pub profile: u8,
    pub hold_output: Option<KeyOutput>,
}

A key with tap-hold functionality.

Fields

tap: R

The ‘tap’ key.

hold: R

The ‘hold’ key.

profile: u8

Behavior profile index: 0 = Config::default_profile; 1.. = Config::profiles.

hold_output: Option<KeyOutput>

HID of the hold binding when it is a keyboard key that is safe to emit while pending.

Nickel fills this in keymap codegen (ncl/smart_keys/tap_hold/keymap-codegen.ncl) from the hold leaf. LeftGUI / RightGUI and non-keyboard holds are None. Used when Profile::pending_output is PendingOutput::Hold.

Implementations

impl<R> Key<R>

pub const fn new(tap: R, hold: R) -> Key<R>

Constructs a new tap-hold key using the default profile (0).

pub const fn with_profile(tap: R, hold: R, profile: u8) -> Key<R>

Constructs a tap-hold key that uses the given behavior profile index.

Trait Implementations

impl<R> Clone for Key<R>

where R: Clone,

fn clone(&self) -> Key<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Copy for Key<R>

where R: Copy,

impl<R> Debug for Key<R>

where R: Debug,

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

Formats the value using the given formatter.

impl<R> Default for Key<R>

where R: Default,

Available on crate feature std only.

fn default() -> Key<R>

Returns the “default value” for a type.

impl<'de, R> Deserialize<'de> for Key<R>

where R: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Key<R>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> PartialEq for Key<R>

where R: PartialEq,

fn eq(&self, other: &Key<R>) -> 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<R> StructuralPartialEq for Key<R>

where R: PartialEq,