Enum ModifierKey

Source
pub enum ModifierKey {
    Hold(LayerIndex),
    SetActiveLayers(LayerBitset),
    Default(LayerIndex),
}
Expand description

Modifier layer key affects what layers are active.

Variants§

§

Hold(LayerIndex)

Activates the given layer when the held.

§

SetActiveLayers(LayerBitset)

Sets the set of active layers to the given layers when the key is pressed.

§

Default(LayerIndex)

Sets the default layer.

Implementations§

Source§

impl ModifierKey

Source

pub const fn hold(layer: LayerIndex) -> Self

Create a new ModifierKey that activates the given layer when held.

Source

pub const fn set_active_layers(layers: &[LayerIndex]) -> Self

Create a new ModifierKey that sets the active layers to the given slice of layers when pressed.

Each LayerIndex in the slice must be less than MAX_BITSET_LAYER.

Source

pub const fn set_active_layers_from_bitset(bitset: LayerBitset) -> Self

Create a new ModifierKey that sets the active layers bitset.

Source

pub const fn default(layer: LayerIndex) -> Self

Create a new ModifierKey that sets the default layer.

Source

pub fn new_pressed_key(&self) -> (ModifierKeyState, LayerEvent)

Create a new input::PressedKey and key::ScheduledEvent for the given keymap index.

Pressing a ModifierKey::Hold emits a LayerEvent::LayerActivated event.

Trait Implementations§

Source§

impl Clone for ModifierKey

Source§

fn clone(&self) -> ModifierKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModifierKey

Source§

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

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

impl<'de> Deserialize<'de> for ModifierKey

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ModifierKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ModifierKey

Source§

impl StructuralPartialEq for ModifierKey

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,