Enum KeyLegend 

pub enum KeyLegend {
    Character(String),
    Left,
    Right,
    Up,
    Down,
    Tab,
    Enter,
    Escape,
    Space,
    Backspace,
    Delete,
    Home,
    End,
    PageUp,
    PageDown,
    Insert,
    PrintScreen,
    NumLock,
    Function(u8),
}

Variants

Character(String)

Left

Right

Up

Down

Tab

Enter

Escape

Space

Backspace

Delete

Home

End

PageUp

PageDown

Insert

PrintScreen

NumLock

Function(u8)

Implementations

impl KeyLegend

pub fn from_name(name: &str) -> KeyLegend

pub fn label(&self, platform: PlatformConventions) -> String

pub fn label_for( &self, _platform: PlatformConventions, family: KeyboardFamily, ) -> String

The legend of this key on a keyboard of family typing with the active layout (crate::keycaps::active).

Trait Implementations

impl Clone for KeyLegend

fn clone(&self) -> KeyLegend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyLegend

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyLegend

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyLegend, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for KeyLegend

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

where __H: Hasher,

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 KeyLegend

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

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

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyLegend

impl StructuralPartialEq for KeyLegend