Struct Keysym 

pub struct Keysym(pub u32);

Input vocabulary, defined in crcbl_core::input and re-exported so a consumer of the event stream needs one use rather than two.

See the crate docs for why these live in crcbl-core. 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: Keysym

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

pub const BACKSPACE: Keysym

XK_BackSpace.

pub const TAB: Keysym

XK_Tab.

pub const RETURN: Keysym

XK_Return.

pub const PAUSE: Keysym

XK_Pause.

pub const SCROLL_LOCK: Keysym

XK_Scroll_Lock.

pub const ESCAPE: Keysym

XK_Escape.

pub const HOME: Keysym

XK_Home.

pub const LEFT: Keysym

XK_Left.

pub const UP: Keysym

XK_Up.

pub const RIGHT: Keysym

XK_Right.

pub const DOWN: Keysym

XK_Down.

pub const PAGE_UP: Keysym

XK_Prior.

pub const PAGE_DOWN: Keysym

XK_Next.

pub const END: Keysym

XK_End.

pub const PRINT: Keysym

XK_Print.

pub const INSERT: Keysym

XK_Insert.

pub const MENU: Keysym

XK_Menu.

pub const NUM_LOCK: Keysym

XK_Num_Lock.

pub const KP_ENTER: Keysym

XK_KP_Enter.

pub const KP_MULTIPLY: Keysym

XK_KP_Multiply.

pub const KP_ADD: Keysym

XK_KP_Add.

pub const KP_SUBTRACT: Keysym

XK_KP_Subtract.

pub const KP_DECIMAL: Keysym

XK_KP_Decimal.

pub const KP_DIVIDE: Keysym

XK_KP_Divide.

pub const KP_0: Keysym

XK_KP_0.

pub const KP_1: Keysym

XK_KP_1.

pub const KP_2: Keysym

XK_KP_2.

pub const KP_3: Keysym

XK_KP_3.

pub const KP_4: Keysym

XK_KP_4.

pub const KP_5: Keysym

XK_KP_5.

pub const KP_6: Keysym

XK_KP_6.

pub const KP_7: Keysym

XK_KP_7.

pub const KP_8: Keysym

XK_KP_8.

pub const KP_9: Keysym

XK_KP_9.

pub const F1: Keysym

XK_F1.

pub const F2: Keysym

XK_F2.

pub const F3: Keysym

XK_F3.

pub const F4: Keysym

XK_F4.

pub const F5: Keysym

XK_F5.

pub const F6: Keysym

XK_F6.

pub const F7: Keysym

XK_F7.

pub const F8: Keysym

XK_F8.

pub const F9: Keysym

XK_F9.

pub const F10: Keysym

XK_F10.

pub const F11: Keysym

XK_F11.

pub const F12: Keysym

XK_F12.

pub const SHIFT_L: Keysym

XK_Shift_L.

pub const SHIFT_R: Keysym

XK_Shift_R.

pub const CONTROL_L: Keysym

XK_Control_L.

pub const CONTROL_R: Keysym

XK_Control_R.

pub const CAPS_LOCK: Keysym

XK_Caps_Lock.

pub const ALT_L: Keysym

XK_Alt_L.

pub const ALT_R: Keysym

XK_Alt_R.

pub const SUPER_L: Keysym

XK_Super_L.

pub const SUPER_R: Keysym

XK_Super_R.

pub const DELETE: Keysym

XK_Delete.

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

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

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<(), Error>

Formats the value using the given formatter.

impl Default for Keysym

fn default() -> Keysym

Returns the “default value” for a type.

impl Display for Keysym

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

Formats the value using the given formatter.

impl Eq for Keysym

impl Hash for Keysym

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 Keysym

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Keysym

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