Enum tetra::input::KeyLabel

source ·
#[non_exhaustive]
pub enum KeyLabel {
Show 129 variants A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Num0, Num1, Num2, Num3, Num4, Num5, Num6, Num7, Num8, Num9, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24, NumLock, NumPad1, NumPad2, NumPad3, NumPad4, NumPad5, NumPad6, NumPad7, NumPad8, NumPad9, NumPad0, NumPadPlus, NumPadMinus, NumPadMultiply, NumPadDivide, NumPadEnter, LeftCtrl, LeftShift, LeftAlt, RightCtrl, RightShift, RightAlt, Up, Down, Left, Right, Ampersand, Asterisk, At, Backquote, Backslash, Backspace, CapsLock, Caret, Colon, Comma, Delete, Dollar, DoubleQuote, End, Enter, Equals, Escape, Exclaim, GreaterThan, Hash, Home, Insert, LeftBracket, LeftParen, LessThan, Minus, PageDown, PageUp, Pause, Percent, Period, Plus, PrintScreen, Question, Quote, RightBracket, RightParen, ScrollLock, Semicolon, Slash, Space, Tab, Underscore,
}
Expand description

A key, as represented by the current system keyboard layout.

This type represents keys based on how they are labelled and what character they generate. For example, KeyLabel::A is the key to the right of the Caps Lock on a QWERTY keyboard, whereas it is the key to the right of Tab on an AZERTY keyboard.

The main use case for KeyLabel is when you need to display a key name to the player (e.g. in tutorials, or on an input binding screen). As such, it implements Display in a UI-friendly way. You can get the label for a given key via get_key_label, and the key with a given label via get_key_with_label.

Serde

Serialization and deserialization of this type (via Serde) can be enabled via the serde_support feature.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

A

§

B

§

C

§

D

§

E

§

F

§

G

§

H

§

I

§

J

§

K

§

L

§

M

§

N

§

O

§

P

§

Q

§

R

§

S

§

T

§

U

§

V

§

W

§

X

§

Y

§

Z

§

Num0

§

Num1

§

Num2

§

Num3

§

Num4

§

Num5

§

Num6

§

Num7

§

Num8

§

Num9

§

F1

§

F2

§

F3

§

F4

§

F5

§

F6

§

F7

§

F8

§

F9

§

F10

§

F11

§

F12

§

F13

§

F14

§

F15

§

F16

§

F17

§

F18

§

F19

§

F20

§

F21

§

F22

§

F23

§

F24

§

NumLock

§

NumPad1

§

NumPad2

§

NumPad3

§

NumPad4

§

NumPad5

§

NumPad6

§

NumPad7

§

NumPad8

§

NumPad9

§

NumPad0

§

NumPadPlus

§

NumPadMinus

§

NumPadMultiply

§

NumPadDivide

§

NumPadEnter

§

LeftCtrl

§

LeftShift

§

LeftAlt

§

RightCtrl

§

RightShift

§

RightAlt

§

Up

§

Down

§

Left

§

Right

§

Ampersand

§

Asterisk

§

At

§

Backquote

§

Backslash

§

Backspace

§

CapsLock

§

Caret

§

Colon

§

Comma

§

Delete

§

Dollar

§

DoubleQuote

§

End

§

Enter

§

Equals

§

Escape

§

Exclaim

§

GreaterThan

§

Hash

§

Home

§

Insert

§

LeftBracket

§

LeftParen

§

LessThan

§

Minus

§

PageDown

§

PageUp

§

Pause

§

Percent

§

Period

§

Plus

§

PrintScreen

§

Question

§

Quote

§

RightBracket

§

RightParen

§

ScrollLock

§

Semicolon

§

Slash

§

Space

§

Tab

§

Underscore

Trait Implementations§

source§

impl Clone for KeyLabel

source§

fn clone(&self) -> KeyLabel

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for KeyLabel

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for KeyLabel

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for KeyLabel

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq<KeyLabel> for KeyLabel

source§

fn eq(&self, other: &KeyLabel) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for KeyLabel

source§

impl Eq for KeyLabel

source§

impl StructuralEq for KeyLabel

source§

impl StructuralPartialEq for KeyLabel

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,