Enum enigo::Key

pub enum Key {
    Alt,
    Backspace,
    CapsLock,
    Command,
    Control,
    Delete,
    DownArrow,
    End,
    Escape,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    Home,
    LeftArrow,
    Meta,
    Option,
    PageDown,
    PageUp,
    Return,
    RightArrow,
    Shift,
    Space,
    Super,
    Tab,
    UpArrow,
    Windows,
    Layout(char),
    Raw(u16),
}

A key on the keyboard. For alphabetical keys, use Key::Layout for a system independent key. If a key is missing, you can use the raw keycode with Key::Raw.

Variants

Alt

alt key on Linux and Windows (option key on macOS)

Backspace

backspace key

CapsLock

caps lock key

Command

👎Deprecated since 0.0.12: now renamed to Meta

command key on macOS (super key on Linux, windows key on Windows)

Control

control key

Delete

delete key

DownArrow

down arrow key

End

end key

Escape

escape key (esc)

F1

F1 key

F2

F2 key

F3

F3 key

F4

F4 key

F5

F5 key

F6

F6 key

F7

F7 key

F8

F8 key

F9

F9 key

F10

F10 key

F11

F11 key

F12

F12 key

F13

F13 key

F14

F14 key

F15

F15 key

F16

F16 key

F17

F17 key

F18

F18 key

F19

F19 key

F20

F20 key

Home

home key

LeftArrow

left arrow key

Meta

meta key (also known as “windows”, “super”, and “command”)

Option

option key on macOS (alt key on Linux and Windows)

PageDown

page down key

PageUp

page up key

Return

return key

RightArrow

right arrow key

Shift

shift key

Space

space key

Super

👎Deprecated since 0.0.12: now renamed to Meta

super key on linux (command key on macOS, windows key on Windows)

Tab

tab key (tabulator)

UpArrow

up arrow key

Windows

👎Deprecated since 0.0.12: now renamed to Meta

windows key on Windows (super key on Linux, command key on macOS)

Layout(char)

keyboard layout dependent key

Raw(u16)

raw keycode eg 0x38

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy 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 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<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key