Skip to main content

Key

Enum Key 

Source
#[non_exhaustive]
pub enum Key {
Show 17 variants Character(char), ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Enter, Tab, Escape, Backspace, Delete, Home, End, PageUp, PageDown, Insert, F(u8), Unidentified,
}
Expand description

A key on the keyboard, as KeyEvent::key names it (docs/menus.md “Keys”).

A key that types is Key::Character with its unmodified character ('a', 'A' under Shift, '8', 'ü' on a layout that has one, ' ' for the space bar); a key that types nothing is one of the named variants. Key::Unidentified stands for text with no single key behind it (an input method’s commit) and for a key outside this vocabulary.

At the boundaries that stay text (a backend’s wire, a dayscript key: step, a menu Shortcut) a key is spelled by its web KeyboardEvent.key name: Key::from_name reads one and Key::name writes it.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Character(char)

A key that types, named by its unmodified character.

§

ArrowLeft

§

ArrowRight

§

ArrowUp

§

ArrowDown

§

Enter

§

Tab

§

Escape

§

Backspace

§

Delete

§

Home

§

End

§

PageUp

§

PageDown

§

Insert

§

F(u8)

A function key, F(1) through F(12).

§

Unidentified

No single key: text an input method committed, or a key this vocabulary does not name.

Implementations§

Source§

impl Key

Source

pub fn from_name(name: &str) -> Key

The key a web KeyboardEvent.key name spells: a named key, "F1" through "F12", a single character, or "Space" for the space bar. Anything else is Key::Unidentified.

Source

pub fn name(self) -> String

The web KeyboardEvent.key name of this key: "ArrowLeft", "F5", "a", and the empty string for Key::Unidentified. The inverse of Key::from_name.

Source

pub fn character(self) -> Option<char>

The character of a key that types, or None for a named key.

Source

pub fn digit(self) -> Option<u8>

The value of a digit key ('0' through '9'), or None for every other key.

Source

pub fn is_arrow(self) -> bool

Whether this is one of the four arrow keys.

Source

pub fn shortcut_name(self) -> String

The name a menu Shortcut spells this key with ("Return", "Left", "F1", "s"): the menu vocabulary every backend’s accelerator table reads, which differs from the web names for Enter and the arrows.

Trait Implementations§

Source§

impl Clone for Key

Source§

fn clone(&self) -> Self

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 Key

Source§

impl Debug for Key

Source§

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

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

impl Display for Key

Source§

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

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

impl Eq for Key

Source§

impl From<&String> for Key

Source§

fn from(name: &String) -> Key

Converts to this type from the input type.
Source§

impl From<&str> for Key

A key by its web name (Key::from_name): what a backend’s key table and a scripted step hold.

Source§

fn from(name: &str) -> Key

Converts to this type from the input type.
Source§

impl From<Cow<'_, str>> for Key

Source§

fn from(name: Cow<'_, str>) -> Key

Converts to this type from the input type.
Source§

impl From<Key> for ShortcutKey

Source§

fn from(key: Key) -> ShortcutKey

Converts to this type from the input type.
Source§

impl From<String> for Key

Source§

fn from(name: String) -> Key

Converts to this type from the input type.
Source§

impl From<char> for Key

Source§

fn from(c: char) -> Key

Converts to this type from the input type.
Source§

impl Hash for Key

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Key

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl Forget for Key

§

impl Freeze for Key

§

impl Move for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnsafeUnpin for Key

§

impl UnwindSafe for Key

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.