Struct ModifierIndex

pub struct ModifierIndex(/* private fields */);

A modifier index.

This is a number between 0 and 31 that indicates a bit in a modifier mask.

See the documentation of ModifierMask for possible meanings of the indices.

Implementations

impl ModifierIndex

pub const SHIFT: Self

The 0 index, corresponding to the XKB shift modifier.

pub const LOCK: Self

The 1 index, corresponding to the XKB lock modifier.

pub const CONTROL: Self

The 2 index, corresponding to the XKB control modifier.

pub const MOD1: Self

The 3 index, corresponding to the XKB mod1 modifier.

pub const ALT: Self

This is an alias for Self::MOD1.

This association exists by convention and is hard-coded in xkbcommon.

pub const MOD2: Self

The 4 index, corresponding to the XKB mod2 modifier.

pub const NUM_LOCK: Self

This is an alias for Self::MOD2.

This association exists by convention and is hard-coded in xkbcommon.

pub const MOD3: Self

The 5 index, corresponding to the XKB mod3 modifier.

pub const MOD4: Self

The 6 index, corresponding to the XKB mod4 modifier.

pub const SUPER: Self

This is an alias for Self::MOD4.

This association exists by convention and is hard-coded in xkbcommon.

pub const MOD5: Self

The 7 index, corresponding to the XKB mod5 modifier.

pub const fn new(index: u32) -> Option<Self>

Creates a new ModifierIndex.

Returns None if the index is larger than 31.

pub const fn raw(self) -> u32

Returns the numeric index.

This value is guaranteed to be less than 32.

pub const fn to_mask(self) -> ModifierMask

Returns the mask corresponding to this index.

assert_eq!(ModifierIndex::SHIFT.to_mask(), ModifierMask::SHIFT);

Trait Implementations

impl Clone for ModifierIndex

fn clone(&self) -> ModifierIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierIndex

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

Formats the value using the given formatter.

impl Hash for ModifierIndex

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 ModifierIndex

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

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

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

impl Eq for ModifierIndex

impl StructuralPartialEq for ModifierIndex