Struct Key

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

A representation of a key code from the console lib binding.

The key should be checked with the constants provided in the Key implementation (Like Key::SPACE).

Unknown keys map to undefined values.

Implementations

impl Key

pub const SPACE: Key

pub const EXCLAMATION_MARK: Key

pub const QUOTATION_MARK: Key

pub const NUMBER_SIGN: Key

pub const DOLLAR: Key

pub const PERCENT_SIGN: Key

pub const AMPERSAND: Key

pub const APOSTROPHE: Key

pub const LEFT_PARENTHESIS: Key

pub const RIGHT_PARENTHESIS: Key

pub const ASTERISK: Key

pub const PLUS: Key

pub const COMMA: Key

pub const MINUS: Key

pub const DOT: Key

pub const SLASH: Key

pub const COLON: Key

pub const SEMICOLON: Key

pub const LESS_THAN_SIGN: Key

pub const EQUALS_SIGN: Key

pub const GREATER_THAN_SIGN: Key

pub const QUESTION_MARK: Key

pub const AT_SIGN: Key

pub const LEFT_BRACKET: Key

pub const BACKSLASH: Key

pub const RIGHT_BRACKET: Key

pub const CARET: Key

pub const UNDERSCORE: Key

pub const BACKTICK: Key

pub const LEFT_CURLY_BRACKET: Key

pub const VERTICAL_BAR: Key

pub const RIGHT_CURLY_BRACKET: Key

pub const TILDE: Key

pub const DIGIT_0: Key

pub const DIGIT_1: Key

pub const DIGIT_2: Key

pub const DIGIT_3: Key

pub const DIGIT_4: Key

pub const DIGIT_5: Key

pub const DIGIT_6: Key

pub const DIGIT_7: Key

pub const DIGIT_8: Key

pub const DIGIT_9: Key

pub const A: Key

pub const B: Key

pub const C: Key

pub const D: Key

pub const E: Key

pub const F: Key

pub const G: Key

pub const H: Key

pub const I: Key

pub const J: Key

pub const K: Key

pub const L: Key

pub const M: Key

pub const N: Key

pub const O: Key

pub const P: Key

pub const Q: Key

pub const R: Key

pub const S: Key

pub const T: Key

pub const U: Key

pub const V: Key

pub const W: Key

pub const X: Key

pub const Y: Key

pub const Z: Key

pub const LEFT: Key

pub const UP: Key

pub const RIGHT: Key

pub const DOWN: Key

pub const F1: Key

pub const F2: Key

pub const F3: Key

pub const F4: Key

pub const F5: Key

pub const F6: Key

pub const F7: Key

pub const F8: Key

pub const F9: Key

pub const F10: Key

pub const F11: Key

pub const F12: Key

pub const ESC: Key

pub const DELETE: Key

pub const ENTER: Key

pub const TAB: Key

impl Key

pub fn is_arrow_key(&self) -> bool

pub fn to_ascii(&self) -> Option<u8>

Converts the keycode to an ASCII character if the key represents an ASCII character.

pub fn is_ascii(&self) -> bool

pub fn is_numeric(&self) -> bool

Checks if a keycode is ASCII and numeric.

pub fn is_alphanumeric(&self) -> bool

Checks if a keycode is ASCII and alphanumeric.

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

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key