Struct KeyCode

#[repr(transparent)]
pub struct KeyCode(pub(crate) RawKeyCode);

The keyboard code, often corresponding to a physical key.

Keyboard events usually return this type directly, and leave it to be the responsibility of the user to convert it to a keyboard symbol.

Tuple Fields

0: RawKeyCode

Implementations

impl KeyCode

pub const fn new(raw: RawKeyCode) -> Self

Create a new KeyCode from a raw keyboard code.

pub const fn raw(self) -> RawKeyCode

Get the raw keyboard code.

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl Default for KeyCode

fn default() -> KeyCode

Returns the “default value” for a type.

impl From<KeyCode> for u16

fn from(keycode: KeyCode) -> Self

Converts to this type from the input type.

impl From<KeyCode> for RawKeyCode

fn from(keycode: KeyCode) -> Self

Converts to this type from the input type.

impl From<KeyCode> for u8

fn from(keycode: KeyCode) -> Self

Converts to this type from the input type.

impl From<u16> for KeyCode

fn from(raw: u16) -> Self

Converts to this type from the input type.

impl From<u32> for KeyCode

fn from(raw: RawKeyCode) -> Self

Converts to this type from the input type.

impl From<u8> for KeyCode

fn from(raw: u8) -> Self

Converts to this type from the input type.

impl Hash for KeyCode

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 KeyCode

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

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

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

impl Eq for KeyCode

impl StructuralPartialEq for KeyCode