Struct KeyMods 

pub struct KeyMods {
    pub shift: bool,
    pub ctrl: bool,
    pub alt: bool,
    pub super_key: bool,
}

Physical modifier state. Unlike Mods — which abstracts platform conventions for the input widget (word, doc) — nothing here is normalized: an app binding Ctrl-w needs to know it was Control and not Command.

Fields

shift: bool

ctrl: bool

alt: bool

super_key: bool

Windows key / Command / Super.

Implementations

impl KeyMods

pub const SHIFT: u32

Bit 0 Shift, 1 Ctrl, 2 Alt, 3 Super — the order the fields are declared in, and the C header’s KUI_KMOD_* (pinned there). What a wire that carries the state as one integer spells it as: the conformance corpus’s modifiers step, the C input door.

pub const CTRL: u32

pub const ALT: u32

pub const SUPER: u32

pub const NONE: KeyMods

No modifier held: what the with_* steps start from — KeyMods::NONE.with_shift().with_ctrl().

pub const fn with_shift(self) -> Self

pub const fn with_ctrl(self) -> Self

pub const fn with_alt(self) -> Self

pub const fn with_super(self) -> Self

pub const fn with_primary(self) -> Self

The platform primary shortcut modifier held: Command on macOS, Control elsewhere — the one Self::primary reads.

pub fn from_bits(bits: u32) -> Self

pub fn bits(self) -> u32

pub fn any(self) -> bool

pub fn any_of(self, other: KeyMods) -> bool

Whether any modifier of other is held here.

pub fn parse(names: &str) -> Self

From the schema’s spelling (the scrollMods row): names separated by spaces or commas — "ctrl", "ctrl super", "shift, alt". A word that is none of the four is skipped, so a string of none of them names nothing.

pub fn to_fields(self) -> Value

{shift=, ctrl=, alt=, super=}: the state as an event carries it under a field of its own (a scroll event’s mods).

pub fn primary(self) -> bool

The platform primary shortcut modifier: Command on macOS, Control elsewhere.

pub fn to_value(self) -> Value

The payload form of a modifier change: {kind="modifiers", shift=, ctrl=, alt=, super=}.

Trait Implementations

impl Clone for KeyMods

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyMods

impl Debug for KeyMods

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

Formats the value using the given formatter.

impl Default for KeyMods

fn default() -> Self

Returns the “default value” for a type.

impl Eq for KeyMods

impl PartialEq for KeyMods

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyMods