Struct NcKey

#[repr(transparent)]
pub struct NcKey(pub u32);

A synthesized input event.

This means any input event we can report that isn’t representative of some Unicode. This covers both keyboard and mouse events, as well as signals and even window events.

See also PRETERUNICODEBASE.

Tuple Fields

0: u32

Implementations

impl NcKey

Constants

pub const Invalid: NcKey

pub const Resize: NcKey

we received SIGWINCH.

pub const Up: NcKey

pub const Right: NcKey

pub const Down: NcKey

pub const Left: NcKey

pub const Ins: NcKey

pub const Del: NcKey

pub const Backspace: NcKey

pub const PgDown: NcKey

pub const PgUp: NcKey

pub const Home: NcKey

pub const End: NcKey

pub const F00: NcKey

pub const F01: NcKey

pub const F02: NcKey

pub const F03: NcKey

pub const F04: NcKey

pub const F05: NcKey

pub const F06: NcKey

pub const F07: NcKey

pub const F08: NcKey

pub const F09: NcKey

pub const F10: NcKey

pub const F11: NcKey

pub const F12: NcKey

pub const F13: NcKey

pub const F14: NcKey

pub const F15: NcKey

pub const F16: NcKey

pub const F17: NcKey

pub const F18: NcKey

pub const F19: NcKey

pub const F20: NcKey

pub const F21: NcKey

pub const F22: NcKey

pub const F23: NcKey

pub const F24: NcKey

pub const F25: NcKey

pub const F26: NcKey

pub const F27: NcKey

pub const F28: NcKey

pub const F29: NcKey

pub const F30: NcKey

pub const F31: NcKey

pub const F32: NcKey

pub const F33: NcKey

pub const F34: NcKey

pub const F35: NcKey

pub const F36: NcKey

pub const F37: NcKey

pub const F38: NcKey

pub const F39: NcKey

pub const F40: NcKey

pub const F41: NcKey

pub const F42: NcKey

pub const F43: NcKey

pub const F44: NcKey

pub const F45: NcKey

pub const F46: NcKey

pub const F47: NcKey

pub const F48: NcKey

pub const F49: NcKey

pub const F50: NcKey

pub const F51: NcKey

pub const F52: NcKey

pub const F53: NcKey

pub const F54: NcKey

pub const F55: NcKey

pub const F56: NcKey

pub const F57: NcKey

pub const F58: NcKey

pub const F59: NcKey

pub const F60: NcKey

pub const Enter: NcKey

pub const Cls: NcKey

“clear-screen or erase”

pub const DLeft: NcKey

down + left on keypad

pub const DRight: NcKey

pub const ULeft: NcKey

up + left on keypad

pub const URight: NcKey

pub const Center: NcKey

pub const Begin: NcKey

pub const Cancel: NcKey

pub const Close: NcKey

pub const Command: NcKey

pub const Copy: NcKey

pub const Exit: NcKey

pub const Print: NcKey

pub const Refresh: NcKey

pub const CapsLock: NcKey

pub const ScrollLock: NcKey

pub const NumLock: NcKey

pub const PrintScreen: NcKey

pub const Pause: NcKey

pub const Menu: NcKey

pub const MediaPlay: NcKey

pub const MediaPause: NcKey

pub const MediaPPause: NcKey

pub const MediaRev: NcKey

pub const MediaStop: NcKey

pub const MediaFF: NcKey

pub const MediaRewind: NcKey

pub const MediaNext: NcKey

pub const MediaPrev: NcKey

pub const MediaRecord: NcKey

pub const MediaLVol: NcKey

pub const MediaRVol: NcKey

pub const MediaMute: NcKey

pub const LShift: NcKey

pub const LCtrl: NcKey

pub const LAlt: NcKey

pub const LSuper: NcKey

pub const LHyper: NcKey

pub const LMeta: NcKey

pub const RShift: NcKey

pub const RCtrl: NcKey

pub const RAlt: NcKey

pub const RSuper: NcKey

pub const RHyper: NcKey

pub const RMeta: NcKey

pub const L3Shift: NcKey

AltGr in european keyboards

pub const L5Shift: NcKey

pub const Motion: NcKey

pub const Button1: NcKey

pub const Button2: NcKey

pub const Button3: NcKey

pub const Button4: NcKey

scrollwheel up

pub const Button5: NcKey

scrollwheel down

pub const Button6: NcKey

pub const Button7: NcKey

pub const Button8: NcKey

pub const Button9: NcKey

pub const Button10: NcKey

pub const Button11: NcKey

pub const Signal: NcKey

we received SIGCONT

pub const Eof: NcKey

Will be returned upon reaching the end of input.

pub const Tab: NcKey

pub const Esc: NcKey

pub const Space: NcKey

impl NcKey

Aliases

pub const ScrollUp: NcKey

Alias of Button4

pub const Scrolldown: NcKey

Alias of Button5

pub const Return: NcKey

Alias of Enter

impl NcKey

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 NcKey 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 NcKey.

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

Returns the name of the NcKey the number would be.

Trait Implementations

impl Clone for NcKey

fn clone(&self) -> NcKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NcKey

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

Formats the value using the given formatter.

impl Display for NcKey

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

Formats the value using the given formatter.

impl From<NcKey> for u32

fn from(k: NcKey) -> Self

Converts to this type from the input type.

impl PartialEq for NcKey

fn eq(&self, other: &NcKey) -> 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 NcKey

impl Eq for NcKey

impl StructuralPartialEq for NcKey