Enum Key

pub enum Key<C = SmolStr> {
    Named(Named),
    Character(C),
    Unidentified,
}

A key on the keyboard.

This is mostly the Key type found in winit.

Variants

Named(Named)

A key with an established name.

Character(C)

A key string that corresponds to the character typed by the user, taking into account the user’s current locale setting, and any system-level keyboard mapping overrides that are in effect.

Unidentified

An unidentified key.

Implementations

impl Key

pub fn as_ref(&self) -> Key<&str>

Convert Key::Character(SmolStr) to Key::Character(&str) so you can more easily match on Key. All other variants remain unchanged.

pub fn to_latin(&self, physical_key: Physical) -> Option<char>

Tries to convert this logical Key into its latin character, using the Physical key provided for translation if it isn’t already in latin.

Returns None if no latin variant could be found.

use iced_core::keyboard::key::{Key, Named, Physical, Code};

// Latin c
assert_eq!(
    Key::Character("c".into()).to_latin(Physical::Code(Code::KeyC)),
    Some('c'),
);

// Cyrillic с
assert_eq!(
    Key::Character("с".into()).to_latin(Physical::Code(Code::KeyC)),
    Some('c'),
);

// Arrow Left
assert_eq!(
    Key::Named(Named::ArrowLeft).to_latin(Physical::Code(Code::ArrowLeft)),
    None,
);

Trait Implementations

impl<C> Clone for Key<C>

where C: Clone,

fn clone(&self) -> Key<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Key<C>

where C: Debug,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for Key<C>

where C: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Named> for Key

fn from(named: Named) -> Key

Converts to this type from the input type.

impl<C> Hash for Key<C>

where C: Hash,

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

where C: Ord,

fn cmp(&self, other: &Key<C>) -> 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<C> PartialEq for Key<C>

where C: PartialEq,

fn eq(&self, other: &Key<C>) -> 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<C> PartialOrd for Key<C>

where C: PartialOrd,

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

where C: Serialize,

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<C> Eq for Key<C>

where C: Eq,

impl<C> StructuralPartialEq for Key<C>