Struct Keysym 

pub struct Keysym(pub u32);

A layout-mapped key symbol, in the X11/XKB keysym numbering.

See the module docs for why that numbering. The values a game actually wants are usually reachable through Keysym::to_char; the raw number matters only for named function keys, which live above 0xFF00.

Tuple Fields

0: u32

Implementations

impl Keysym

pub const NONE: Self

No symbol — a key that produces nothing in the current layout, or a backend that could not map one. XKB_KEY_NoSymbol.

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

The character this symbol produces, if it produces one.

Implements the two rules XKB uses: keysyms 0x20..=0x7E and 0xA0..=0xFF are Latin-1 directly, and everything else that maps to a character is 0x0100_0000 | codepoint. Function keys, modifiers and dead keys return None.

This deliberately does not cover the several hundred legacy non-Latin-1 keysyms that predate the Unicode block (Greek, Cyrillic and friends in 0x05xx–0x07xx). Text input is delivered as committed strings, not reconstructed from keysyms, so the table would exist only to be wrong in a way nobody notices; a shortcut label falls back to the KeyCode name.

pub const fn from_char(character: char) -> Self

The keysym for a character, in the canonical form XKB produces.

pub const fn is_none(self) -> bool

Whether this is Keysym::NONE.

Trait Implementations

impl Clone for Keysym

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Keysym

impl Debug for Keysym

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

Formats the value using the given formatter.

impl Default for Keysym

fn default() -> Self

Returns the “default value” for a type.

impl Display for Keysym

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

Formats the value using the given formatter.

impl Eq for Keysym

impl Hash for Keysym

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 Keysym

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Keysym

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Keysym

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for Keysym