Key

hojicha_runtime

Enum Key

pub enum Key {
Show 36 variants
    Char(char),
    Backspace,
    Enter,
    Left,
    Right,
    Up,
    Down,
    Home,
    End,
    PageUp,
    PageDown,
    Tab,
    Delete,
    Insert,
    Esc,
    F(u8),
    Null,
    CapsLock,
    ScrollLock,
    NumLock,
    PrintScreen,
    Pause,
    Menu,
    KeypadBegin,
    MediaPlay,
    MediaPause,
    MediaPlayPause,
    MediaStop,
    MediaNext,
    MediaPrevious,
    MediaFastForward,
    MediaRewind,
    MediaVolumeUp,
    MediaVolumeDown,
    MediaMute,
    Modifier(ModifierKey),
}

Expand description

Represents a key on the keyboard

Variants§

Char(char)

A character key

Backspace

Backspace key

Enter

Enter/Return key

Left

Left arrow

Right

Right arrow

Up

Up arrow

Down

Down arrow

Home

Home key

End

End key

PageUp

Page up

PageDown

Page down

Tab

Tab key

Delete

Delete key

Insert

Insert key

Esc

Escape key

F(u8)

Function keys

Null

Null key (usually Ctrl+@)

CapsLock

Caps Lock key

ScrollLock

Scroll Lock key

NumLock

Num Lock key

PrintScreen

Print Screen key

Pause

Pause/Break key

Menu/Application key

KeypadBegin

Keypad Begin (5 on keypad with NumLock off)

MediaPlay

Media Play

MediaPause

Media Pause

MediaPlayPause

Media Play/Pause toggle

MediaStop

Media Stop

MediaNext

Media Next Track

MediaPrevious

Media Previous Track

MediaFastForward

Media Fast Forward

MediaRewind

Media Rewind

MediaVolumeUp

Media Volume Up

MediaVolumeDown

Media Volume Down

MediaMute

Media Mute

Modifier(ModifierKey)

Modifier key (Shift, Ctrl, Alt, Super/Meta)

Trait Implementations§

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Key

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

Formats the value using the given formatter. Read more

impl Hash for Key

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

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

impl PartialEq for Key

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

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

1.0.0 · 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.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key

Auto Trait Implementations§

impl Freeze for Key

impl RefUnwindSafe for Key

impl Send for Key

impl Sync for Key

impl Unpin for Key

impl UnwindSafe for Key

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Inspectable for T

fn inspect(self, label: &str) -> Self
where Self: Debug,

Inspect this value with a label

fn inspect_if(self, condition: bool, label: &str) -> Self
where Self: Debug,

Conditionally inspect this value

fn inspect_with<F>(self, label: &str, f: F) -> Self
where F: FnOnce(&Self) -> String,

Inspect with a custom formatter

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Tap into the value for side effects

fn tap_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&Self),

Conditionally tap into the value

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Message for T
where T: Send + 'static,