Struct Accel 

pub struct Accel {
    pub mods: AccelMods,
    pub key: Key,
}

A keyboard accelerator: a chord of modifier roles plus a key.

Build one with Accel::primary and the chainable shift / alt / secondary builders, or parse the conventional string form ("Ctrl+Shift+R", "Ctrl+Enter") via From<&str> — in strings, Ctrl and Cmd both mean the primary role. Exotic combinations without primary can be built from the public fields.

Fields

mods: AccelMods

key: Key

Implementations

impl Accel

pub fn primary(key: impl Into<Key>) -> Self

A chord of the primary command modifier plus key — the everyday accelerator: Accel::primary('r'), Accel::primary(NamedKey::Enter).

pub fn shift(self) -> Self

Add Shift to the chord.

pub fn alt(self) -> Self

Add Alt (⌥ Option) to the chord.

pub fn secondary(self) -> Self

Add the secondary system modifier (⌃ on macOS, Super elsewhere) to the chord. Best-effort outside macOS — see the module docs.

pub fn matches( &self, key: Key, modifiers: Modifiers, scheme: ModifierScheme, ) -> bool

Whether the pressed key + modifiers are exactly this chord under scheme. Modifiers must match exactly (a Ctrl+R accel does not fire on Ctrl+Shift+R); character keys compare case-insensitively. AltGr chords never match — the right Alt composes characters (and Windows reports it as Ctrl+Alt), so those keystrokes are text entry, not commands.

pub fn label(&self, scheme: ModifierScheme) -> String

The chord’s display label under scheme, e.g. "Ctrl+Shift+R" on PC and "Shift+Cmd+R" on a Mac. Modifier order follows each platform’s convention: Ctrl, Super, Alt, Shift on PC; Ctrl, Opt, Shift, Cmd (Apple’s ⌃⌥⇧⌘) on macOS.

Trait Implementations

impl Clone for Accel

fn clone(&self) -> Accel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Accel

impl Debug for Accel

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

Formats the value using the given formatter.

impl Eq for Accel

impl From<&str> for Accel

fn from(s: &str) -> Self

Parse the conventional "Ctrl+Shift+R" string form. Modifier tokens (case-insensitive): Ctrl / Cmd / Command / Primary → the primary role; Super / Win / Secondary → secondary; Alt / Opt / Option → alt; Shift. The final token is the key: a single character, or a named key (Enter, Esc, Left, PageUp, …).

Panics

On malformed input. Accelerator strings are in practice compile-time constants, so a typo should fail loudly at first use, not bind nothing.

impl PartialEq for Accel

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