Struct KeyStroke 

pub struct KeyStroke {
    pub key: ShortcutKey,
    pub ctrl: bool,
    pub shift: bool,
    pub alt: bool,
    pub meta: bool,
}

A key plus its modifiers — both the pattern a shortcut is bound to and the description of what was actually pressed. One type, because they are compared to each other and a second one would only be the first with the fields renamed.

Fields

key: ShortcutKey

The key itself.

ctrl: bool

Control (or Command on macOS, where the shell maps it here).

shift: bool

Shift.

alt: bool

Alt / Option.

meta: bool

The platform’s “logo” key, when it is not already folded into ctrl.

Implementations

impl KeyStroke

pub const fn new(key: ShortcutKey) -> Self

A bare key, no modifiers.

pub const fn ctrl(self) -> Self

With Control held.

pub const fn shift(self) -> Self

With Shift held.

pub const fn alt(self) -> Self

With Alt held.

pub const fn meta(self) -> Self

With the logo key held.

pub const fn is_command(&self) -> bool

Does this stroke carry a modifier that makes it a command rather than typing? Shift alone does not: Shift+A is a capital A.

pub fn matches(&self, bound: &KeyStroke) -> bool

Do a pressed stroke and a bound one match? Letters are compared without case, so a binding written Char('s') answers a Shift-less S from a keyboard with Caps Lock on.

Trait Implementations

impl Clone for KeyStroke

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 KeyStroke

impl Debug for KeyStroke

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

Formats the value using the given formatter.

impl Eq for KeyStroke

impl PartialEq for KeyStroke

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyStroke