Struct Key 

pub struct Key(/* private fields */);

A synthesized Received input event other than a char.

Implementations

impl Key

constants

pub const Invalid: Key

pub const Resize: Key

we received SIGWINCH.

pub const Up: Key

pub const Right: Key

pub const Down: Key

pub const Left: Key

pub const Ins: Key

pub const Del: Key

pub const Backspace: Key

pub const PgDown: Key

pub const PgUp: Key

pub const Home: Key

pub const End: Key

pub const F00: Key

pub const F01: Key

pub const F02: Key

pub const F03: Key

pub const F04: Key

pub const F05: Key

pub const F06: Key

pub const F07: Key

pub const F08: Key

pub const F09: Key

pub const F10: Key

pub const F11: Key

pub const F12: Key

pub const F13: Key

pub const F14: Key

pub const F15: Key

pub const F16: Key

pub const F17: Key

pub const F18: Key

pub const F19: Key

pub const F20: Key

pub const F21: Key

pub const F22: Key

pub const F23: Key

pub const F24: Key

pub const F25: Key

pub const F26: Key

pub const F27: Key

pub const F28: Key

pub const F29: Key

pub const F30: Key

pub const F31: Key

pub const F32: Key

pub const F33: Key

pub const F34: Key

pub const F35: Key

pub const F36: Key

pub const F37: Key

pub const F38: Key

pub const F39: Key

pub const F40: Key

pub const F41: Key

pub const F42: Key

pub const F43: Key

pub const F44: Key

pub const F45: Key

pub const F46: Key

pub const F47: Key

pub const F48: Key

pub const F49: Key

pub const F50: Key

pub const F51: Key

pub const F52: Key

pub const F53: Key

pub const F54: Key

pub const F55: Key

pub const F56: Key

pub const F57: Key

pub const F58: Key

pub const F59: Key

pub const F60: Key

pub const Enter: Key

pub const Cls: Key

“clear-screen or erase”

pub const DLeft: Key

down + left on keypad

pub const DRight: Key

pub const ULeft: Key

up + left on keypad

pub const URight: Key

pub const Center: Key

pub const Begin: Key

pub const Cancel: Key

pub const Close: Key

pub const Command: Key

pub const Copy: Key

pub const Exit: Key

pub const Print: Key

pub const Refresh: Key

pub const CapsLock: Key

pub const ScrollLock: Key

pub const NumLock: Key

pub const PrintScreen: Key

pub const Pause: Key

pub const Menu: Key

pub const MediaPlay: Key

pub const MediaPause: Key

pub const MediaPPause: Key

pub const MediaRev: Key

pub const MediaStop: Key

pub const MediaFF: Key

pub const MediaRewind: Key

pub const MediaNext: Key

pub const MediaPrev: Key

pub const MediaRecord: Key

pub const MediaLVol: Key

pub const MediaRVol: Key

pub const MediaMute: Key

pub const LShift: Key

pub const LCtrl: Key

pub const LAlt: Key

pub const LSuper: Key

pub const LHyper: Key

pub const LMeta: Key

pub const RShift: Key

pub const RCtrl: Key

pub const RAlt: Key

pub const RSuper: Key

pub const RHyper: Key

pub const RMeta: Key

pub const L3Shift: Key

AltGr in european keyboards

pub const L5Shift: Key

pub const Motion: Key

pub const Button1: Key

pub const Button2: Key

pub const Button3: Key

pub const Button4: Key

scrollwheel up

pub const Button5: Key

scrollwheel down

pub const Button6: Key

pub const Button7: Key

pub const Button8: Key

pub const Button9: Key

pub const Button10: Key

pub const Button11: Key

pub const Signal: Key

we received SIGCONT

pub const Eof: Key

Will be returned upon reaching the end of input.

pub const Tab: Key

pub const Esc: Key

pub const Space: Key

impl Key

Aliases

pub const ScrollUp: Key

Alias of Button4

pub const Scrolldown: Key

Alias of Button5

pub const Return: Key

Alias of Enter

impl Key

methods

pub fn is(num: u32) -> bool

Checks whether a number falls in the range of synthesized events.

pub fn new(num: u32) -> Option<Self>

Returns a new Key if the provided number falls in the correct range.

pub fn is_function(&self) -> bool

Returns true if it’s a function key event.

pub fn is_media(&self) -> bool

Returns true if it’s a multimedia key event.

pub fn is_mouse(&self) -> bool

Returns true if it’s a mouse event.

pub fn is_resize(&self) -> bool

Returns true if it’s a resize event.

pub fn name(&self) -> &'static str

Returns the name of the current Key.

pub fn check_name(num: u32) -> &'static str

Returns the name of the Key the number would be.

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<Key> for NcKey

fn from(k: Key) -> NcKey

Converts to this type from the input type.

impl From<NcKey> for Key

fn from(nc: NcKey) -> Key

Converts to this type from the input type.

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 Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key