Struct Key

pub struct Key { /* private fields */ }

Defines the inputted virtual keycode

Implementations

impl Key

pub const None: Key

None

pub const Button: Key

Button

pub const BackSpace: Key

BackSpace

pub const Tab: Key

Tab

pub const IsoKey: Key

IsoKey

pub const Enter: Key

Enter

pub const Pause: Key

Pause

pub const ScrollLock: Key

ScrollLock

pub const Escape: Key

Escape

pub const Kana: Key

Kana

pub const Eisu: Key

Eisu

pub const Yen: Key

Yen

pub const JISUnderscore: Key

JISUnderscore

pub const Home: Key

Home

pub const Left: Key

Left

pub const Up: Key

Up

pub const Right: Key

Right

pub const Down: Key

Down

pub const PageUp: Key

PageUp

pub const PageDown: Key

PageDown

pub const End: Key

End

pub const Print: Key

Print

pub const Insert: Key

Insert

pub const Menu: Key

Menu

pub const Help: Key

Help

pub const NumLock: Key

NumLock

pub const KP: Key

Keypad

pub const KPEnter: Key

Keypad Enter

pub const KPLast: Key

Keypad Last

pub const F1: Key

F1

pub const F2: Key

F2

pub const F3: Key

F3

pub const F4: Key

F4

pub const F5: Key

F5

pub const F6: Key

F6

pub const F7: Key

F7

pub const F8: Key

F8

pub const F9: Key

F9

pub const F10: Key

F10

pub const F11: Key

F11

pub const F12: Key

F12

pub const FLast: Key

Function key last

pub const ShiftL: Key

Shift Left

pub const ShiftR: Key

Shift Right

pub const ControlL: Key

Control Left

pub const ControlR: Key

Control Right

pub const CapsLock: Key

Caps Lock

pub const MetaL: Key

Meta Left

pub const MetaR: Key

Meta Right

pub const AltL: Key

Alt Left

pub const AltR: Key

Alt Right

pub const Delete: Key

Delete

pub const fn bits(&self) -> i32

Gets the i32 value of a Key

pub const fn from_i32(val: i32) -> Key

Gets a Key from an i32

pub const fn from_char(val: char) -> Key

Gets a Key from a char

Examples found in repository

examples/pong.rs (line 5)

const KEY_A: Key = Key::from_char('a');
const KEY_D: Key = Key::from_char('d');

pub const fn to_char(&self) -> Option<char>

Get the char representation of a Key.

pub const fn is_fn_key(key: Key) -> bool

Returns whether a key is a function key

pub const fn fn_key(val: i32) -> Key

Return the corresponding function key

Trait Implementations

impl BitOr<Key> for Shortcut

type Output = Shortcut

The resulting type after applying the | operator.

fn bitor(self, other: Key) -> Self::Output

Performs the | operation.

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