Enum KeyMatch

#[non_exhaustive]
pub enum KeyMatch {
    None,
    Partial,
    Exact,
}

Describes how well an event matches a given keyval and modifiers.

KeyMatch values are returned by KeyEvent::matches().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

The key event does not match

Partial

The key event matches if keyboard state (specifically, the currently active group) is ignored

Exact

The key event matches

Trait Implementations

impl Clone for KeyMatch

fn clone(&self) -> KeyMatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyMatch

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

Formats the value using the given formatter.

impl From<KeyMatch> for Value

fn from(v: KeyMatch) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for KeyMatch

type Checker = GenericValueTypeChecker<KeyMatch>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for KeyMatch

type ParamSpec = ParamSpecEnum

type SetValue = KeyMatch

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: KeyMatch) -> ParamSpecEnumBuilder<'_, KeyMatch>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for KeyMatch

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 KeyMatch

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for KeyMatch

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for KeyMatch

type Type = KeyMatch

Type to get the Type from.

impl Copy for KeyMatch

impl Eq for KeyMatch

impl StructuralPartialEq for KeyMatch