Struct KeyCombo 

pub struct KeyCombo { /* private fields */ }

A platform-neutral keyboard chord.

Human-readable formats store the canonical text chord; binary IPC stores validated modifier bits and a USB HID usage.

Implementations

impl KeyCombo

pub const fn key(&self) -> KeyboardUsage

USB HID keyboard usage for the ordinary key.

pub const fn has_command(&self) -> bool

Whether the chord includes Command, the cross-platform primary modifier: Command on macOS, Control on Linux and Windows.

pub const fn has_shift(&self) -> bool

Whether the chord includes Shift.

pub const fn has_control(&self) -> bool

Whether the chord includes Control.

pub const fn has_option(&self) -> bool

Whether the chord includes Option/Alt.

pub const fn has_super(&self) -> bool

Whether the chord includes the logo key, written Super, Win, or Meta: Command on macOS, the Windows key, KEY_LEFTMETA on Linux. Unlike Self::has_command, it never becomes Control.

pub fn rendered_label(&self) -> String

Canonical user-facing chord label.

pub fn rendered_modifiers(&self) -> Option<String>

Canonical label for the chord’s modifiers alone, or None when it carries none. An action that holds the modifiers while tapping the ordinary key separately labels the two halves separately too.

pub fn rendered_key(&self) -> String

Canonical label for the chord’s ordinary key alone.

Trait Implementations

impl Clone for KeyCombo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCombo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyCombo

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyCombo

impl FromStr for KeyCombo

type Err = KeyComboParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KeyCombo

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 KeyCombo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KeyCombo

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyCombo