Enum KeyMod 

#[non_exhaustive]
#[repr(u8)]
pub enum KeyMod {
    LeftShift = 0,
    LeftControl = 1,
    LeftAlt = 2,
    LeftSuper = 3,
    RightShift = 4,
    RightControl = 5,
    RightAlt = 6,
    RightSuper = 7,
    AltGr = 8,
    IsoLevel5Shift = 9,
}

Available on crate feature event only.

🎮 ∈ Modifier key codes (when pressed by themselves)

---

^{📍 ui/event}

---

These keys modify the behavior of other keys when held down.

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.

LeftShift = 0

Left Shift key.

LeftControl = 1

Left Control (Control) key.

LeftAlt = 2

Left Alt key.

LeftSuper = 3

Left Super key (Windows key on Windows, Command ⌘ on macOS).

RightShift = 4

Right Shift key.

RightControl = 5

Right Control key.

RightAlt = 6

Right Alt key.

RightSuper = 7

Right Super key (Windows key on Windows, Command ⌘ on macOS).

AltGr = 8

Used to access alternative characters on some keyboards.

Also known as ISO Level 3 Shift.

IsoLevel5Shift = 9

ISO Level 5 Shift key (used in some advanced keyboard layouts).

Implementations

impl KeyMod

pub const fn from_web_code(code: &str, location: WebKeyLocation) -> Option<Self>

Available on crate feature web only.

Atempts to construct a KeyMod from a JavaScript KeyboardEvent physical code and location.

pub const fn to_web_code(self) -> (&'static str, WebKeyLocation)

Available on crate feature web only.

Returns a JavaScript KeyboardEvent physical code and location.

pub const fn from_web_key(key: &str, location: WebKeyLocation) -> Option<Self>

Available on crate feature web only.

Atempts to construct a KeyMod from a JavaScript KeyboardEvent semantic key and location.

pub const fn to_web_key(self) -> (&'static str, WebKeyLocation)

Available on crate feature web only.

Returns a JavaScript KeyboardEvent semantic key and location.

impl KeyMod

pub const IsoLevel3Shift: KeyMod = KeyMod::AltGr

AltGr key.

Trait Implementations

impl Clone for KeyMod

fn clone(&self) -> KeyMod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for KeyMod

const INIT: Self = Self::LeftShift

Returns the compile-time “initial value” for a type.

impl Copy for KeyMod

impl Debug for KeyMod

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

Formats the value using the given formatter.

impl Eq for KeyMod

impl From<KeyMod> for Key

fn from(code: KeyMod) -> Key

Converts to this type from the input type.

impl Hash for KeyMod

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyMod

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