Struct KeyModifiers 

pub struct KeyModifiers(/* private fields */);

Keyboard modifier flags.

Implemented as a manual bitflag over u8 (SHIFT = 1, CONTROL = 2, ALT = 4, SUPER = 8) rather than a bitflags-generated type, so this stays a plain value type with no macro-generated API surface. Combine with |.

Implementations

impl KeyModifiers

pub const NONE: KeyModifiers

No modifiers.

pub const SHIFT: KeyModifiers

Shift key.

pub const CONTROL: KeyModifiers

Control key.

pub const ALT: KeyModifiers

Alt key.

pub const SUPER: KeyModifiers

Super/Meta key (macOS Cmd, Windows/Super key).

pub const fn from_bits_truncate(bits: u8) -> KeyModifiers

Builds modifiers from a raw bitmask, silently ignoring any bits above SUPER (0b1111).

Bitmask layout: SHIFT = 1, CONTROL = 2, ALT = 4, SUPER = 8. This is the wire format shared by backends that encode modifiers as a single byte (for example the WASM backend’s JS/Rust boundary).

pub const fn from_parts( shift: bool, control: bool, alt: bool, super_: bool, ) -> KeyModifiers

Builds modifiers from four independent flags, one per platform modifier key.

Naming all four as separate parameters (rather than taking a platform-specific modifiers type) makes the modifier set exhaustive by function signature: a backend that gains a fifth modifier fails to compile at every call site instead of silently dropping it.

pub const fn bits(self) -> u8

Returns the raw bitmask, in the same layout from_bits_truncate accepts. Only the low four bits are ever set.

pub const fn contains(self, other: KeyModifiers) -> bool

Returns true if all bits in other are set in self.

pub const fn is_empty(self) -> bool

Returns true if no modifiers are set.

Trait Implementations

impl BitAnd for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the & operator.

fn bitand(self, rhs: KeyModifiers) -> KeyModifiers

Performs the & operation.

impl BitAndAssign for KeyModifiers

fn bitand_assign(&mut self, rhs: KeyModifiers)

Performs the &= operation.

impl BitOr for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the | operator.

fn bitor(self, rhs: KeyModifiers) -> KeyModifiers

Performs the | operation.

impl BitOrAssign for KeyModifiers

fn bitor_assign(&mut self, rhs: KeyModifiers)

Performs the |= operation.

impl Clone for KeyModifiers

fn clone(&self) -> KeyModifiers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyModifiers

impl Debug for KeyModifiers

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

Formats the value using the given formatter.

impl Default for KeyModifiers

fn default() -> KeyModifiers

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyModifiers

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyModifiers

impl Hash for KeyModifiers

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

where __H: Hasher,

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 Not for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the ! operator.

fn not(self) -> KeyModifiers

Performs the unary ! operation.

impl PartialEq for KeyModifiers

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyModifiers