Skip to main content

KeyHint

Struct KeyHint 

Source
pub struct KeyHint {
    pub modifiers: Modifiers,
    pub code: KeyCode,
}
Expand description

Structured keybinding hint for menu rows.

Display is canonicalized (Ctrl+Shift+Z), so inconsistent free text ("ctrl + l" vs "Ctrl+U") is impossible by construction. The hinted key is a KeyCode, shared with hook matching and keymaps.

Fields§

§modifiers: Modifiers

Active modifiers, rendered first in canonical Ctrl, Alt, Shift, Meta order.

§code: KeyCode

The hinted key.

Implementations§

Source§

impl KeyHint

Source

pub fn new(code: KeyCode, modifiers: Modifiers) -> Self

Creates a hint. Single ASCII lowercase Char keys uppercase for canonical form (Char('l') and Char('L') compare and render identically); everything else is stored verbatim.

Source

pub fn ctrl(code: KeyCode) -> Self

Single-modifier helpers for the common cases.

Source

pub fn alt(code: KeyCode) -> Self

Single-modifier helper (Alt / Option).

Source

pub fn shift(code: KeyCode) -> Self

Single-modifier helper.

Source

pub fn meta(code: KeyCode) -> Self

Single-modifier helper (Meta / Command / Windows).

Source

pub fn parts(&self) -> Vec<String>

Display parts in render order: active modifiers first (canonical Ctrl, Alt, Shift, Meta order), then the display key. One kbd chip per part.

Trait Implementations§

Source§

impl Clone for KeyHint

Source§

fn clone(&self) -> KeyHint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for KeyHint

Source§

impl Debug for KeyHint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for KeyHint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for KeyHint

Source§

impl PartialEq for KeyHint

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for KeyHint

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.