Struct Chord 

pub struct Chord {
    pub mods: Mods,
    pub key: Key,
}

One key chord: modifiers plus a key.

Fields

mods: Mods

key: Key

Implementations

impl Chord

pub fn is_menu_safe(&self) -> bool

Whether the chord may become a native menu key equivalent. Only ones with ⌘ / Ctrl (or a function key) do: a bare V or an Alt/Shift-only key would be swallowed by the menu while the user types into a text field, so those stay the app’s own window shortcuts.

impl Chord

pub const fn new(mods: Mods, key: Key) -> Self

pub fn parse(text: &str) -> Result<Chord, ParseError>

Parse one shortcut (Mod+Shift+S, Cmd+Z, Ctrl+Alt+Delete, ⌘⇧S, Mod++, F5).

pub fn portable(&self) -> String

The portable form (Mod+Ctrl+Alt+Shift+K), what settings files and discovery carry.

pub fn display(&self, platform: Platform) -> String

The chord as the user sees it: ⌘⇧S on macOS, Ctrl+Shift+S elsewhere.

pub fn on(self, platform: Platform) -> Chord

The chord as the keyboard of platform produces it: off macOS, Mod and Ctrl are the same key, so both fold into command. Compare chords in this form.

Trait Implementations

impl Clone for Chord

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 Chord

impl Debug for Chord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Chord

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Chord

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

Formats the value using the given formatter.

impl Eq for Chord

impl FromStr for Chord

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Chord

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 Ord for Chord

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Chord

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Chord

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Chord

fn serialize<Ser: Serializer>(&self, s: Ser) -> Result<Ser::Ok, Ser::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Chord