Struct xkeysym::Keysym

pub const fn new(raw: RawKeysym) -> Self

Create a new Keysym from a raw keyboard symbol.

pub const fn raw(self) -> RawKeysym

Get the raw keyboard symbol.

pub const fn name(self) -> Option<&'static str>

Get a string corresponding to the name of this keyboard symbol.

The output of this function is not stable and is intended for debugging purposes.

pub const fn is_keypad_key(self) -> bool

Tell whether a keysym is a keypad key.

pub const fn is_private_keypad_key(self) -> bool

Tell whether a keysym is a private keypad key.

pub const fn is_cursor_key(self) -> bool

Tell whether a keysym is a cursor key.

pub const fn is_pf_key(self) -> bool

Tell whether a keysym is a PF key.

pub const fn is_function_key(self) -> bool

Tell whether a keysym is a function key.

pub const fn is_misc_function_key(self) -> bool

Tell whether a key is a miscellaneous function key.

pub const fn is_modifier_key(self) -> bool

Tell whether a key is a modifier key.

pub fn key_char(self) -> Option<char>

Translate a keyboard symbol to its approximate character.

The translation follows the xkb_keysym_to_utf32 function.

pub fn from_char(ch: char) -> Self

Create a Keysym from the given char.

This function replecates the xkb_utf32_to_keysym behavior.

Trait Implementations§

impl Clone for Keysym

fn clone(&self) -> Keysym

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

impl Debug for Keysym

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

Formats the value using the given formatter. Read more

impl Default for Keysym

fn default() -> Keysym

Returns the “default value” for a type. Read more

impl From<Keysym> for u32

fn from(keysym: Keysym) -> Self

Converts to this type from the input type.

impl From<u32> for Keysym

fn from(raw: u32) -> Self

Converts to this type from the input type.

impl Hash for Keysym

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

impl Ord for Keysym

fn cmp(&self, other: &Keysym) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl PartialEq for Keysym

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

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. Read more

1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Copy for Keysym

impl Eq for Keysym

impl StructuralEq for Keysym

impl StructuralPartialEq for Keysym

Auto Trait Implementations§

impl RefUnwindSafe for Keysym

impl Send for Keysym

impl Sync for Keysym

impl Unpin for Keysym

impl UnwindSafe for Keysym

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.