Struct KeyMods 

pub struct KeyMods(pub u8);

Modifier bitfield. Copy + Eq + Hash so the whole KeyChord fits in a CPU register.

The raw u8 is public for adapters; prefer the named constants, which combine with | (or Self::with).

Examples

use lattice_protocol::KeyMods;

let mods = KeyMods::CTRL | KeyMods::ALT;
assert!(mods.ctrl() && mods.alt() && !mods.shift());
assert_eq!(mods.without(KeyMods::ALT), KeyMods::CTRL);
assert!(KeyMods::NONE.is_empty());

Tuple Fields

0: u8

Implementations

impl KeyMods

pub const NONE: Self

No modifiers.

pub const CTRL: Self

Control — C- in notation.

pub const SHIFT: Self

Shift — S- in notation (only carried for non-letter keys).

pub const ALT: Self

Alt / Meta — M- in notation.

pub const SUPER: Self

Super / Cmd / Windows — D- in notation.

pub const fn ctrl(self) -> bool

Whether Control is held.

pub const fn shift(self) -> bool

Whether Shift is held.

pub const fn alt(self) -> bool

Whether Alt / Meta is held.

pub const fn super_(self) -> bool

Whether Super is held. (Trailing underscore: super is a keyword.)

pub const fn is_empty(self) -> bool

Whether no modifier is held.

pub const fn with(self, other: Self) -> Self

Add other’s modifiers (a const spelling of self | other).

pub const fn without(self, other: Self) -> Self

Strip a modifier (used by renderer adapters to clear the redundant SHIFT bit on bare printable chars where the terminal already encoded shift in the case / shifted symbol).

Trait Implementations

impl BitOr for KeyMods

type Output = KeyMods

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for KeyMods

fn clone(&self) -> KeyMods

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() -> KeyMods

Returns the “default value” for a type.

impl Eq for KeyMods

impl Hash for KeyMods

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 KeyMods

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyMods