Enum Key 

pub enum Key {
    ArrowUp,
    ArrowDown,
    ArrowLeft,
    ArrowRight,
    Home,
    End,
    PageUp,
    PageDown,
    Enter,
    Tab,
    Space,
    Backspace,
    Delete,
    Insert,
    Escape,
    Shift,
    Control,
    Alt,
    Super,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    CapsLock,
    NumLock,
    ScrollLock,
    PrintScreen,
    Pause,
    ContextMenu,
    Copy,
    Cut,
    Paste,
    Undo,
    Redo,
    Char(char),
    Named(String),
}

A keyboard key.

Common keys have dedicated variants for compile-time safety and IDE autocomplete. Rare keys (media, TV remote, IME) use the Named fallback with the iced/winit PascalCase name string.

Variants

ArrowUp

Arrow Up.

ArrowDown

Arrow Down.

ArrowLeft

Arrow Left.

ArrowRight

Arrow Right.

Home

Home.

End

End.

PageUp

Page Up.

PageDown

Page Down.

Enter

Enter.

Tab

Tab.

Space

Space.

Backspace

Backspace.

Delete

Delete.

Insert

Insert.

Escape

Escape.

Shift

Shift.

Control

Control.

Alt

Alt.

Super

Super.

F1

F1.

F2

F2.

F3

F3.

F4

F4.

F5

F5.

F6

F6.

F7

F7.

F8

F8.

F9

F9.

F10

F10.

F11

F11.

F12

F12.

CapsLock

Caps Lock.

NumLock

Num Lock.

ScrollLock

Scroll Lock.

PrintScreen

Print Screen.

Pause

Pause.

ContextMenu

Context Menu.

Copy

Copy.

Cut

Cut.

Paste

Paste.

Undo

Undo.

Redo

Redo.

Char(char)

Char.

Named(String)

A named key not covered by the common variants above.

Uses the iced/winit PascalCase name (e.g. “MediaPlay”, “BrowserBack”, “LaunchMail”). Forward-compatible: new iced key names work without updating this enum.

Implementations

impl Key

pub fn wire_name(&self) -> String

The canonical wire-format name for this key.

Returns the PascalCase name that the renderer and iced use.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&str> for Key

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Key> for KeyPress

fn from(key: Key) -> Self

Converts to this type from the input type.

impl From<String> for Key

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<char> for Key

fn from(c: char) -> Self

Converts to this type from the input type.

impl Hash for Key

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 Key

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Key

impl StructuralPartialEq for Key