Enum ParseKeyError 

pub enum ParseKeyError {
    Empty,
    EmptyComponent,
    UnknownModifier(String),
    UnknownKey(String),
    InvalidFunctionKey(String),
}

Error produced when parsing a Key or KeyCode from a binding string.

Parsing is used by Key::matches, std::str::FromStr for Key, and std::str::FromStr for KeyCode. The variants retain the offending token where useful so configuration UIs can report actionable messages.

Variants

Empty

Input was empty or whitespace-only.

EmptyComponent

A +-separated component was empty.

Examples include "ctrl++a", "ctrl+", and strings with a leading separator such as "+a".

UnknownModifier(String)

A modifier token was not recognized.

The contained string is the exact modifier component that failed to parse, before any case normalization beyond comparison.

UnknownKey(String)

The terminal key token was not recognized.

The contained string is the key component after modifiers have been split off. Single-character tokens are accepted as KeyCode::Char, so this usually indicates an unknown named key.

InvalidFunctionKey(String)

A function-key token (f<n>) had an out-of-range index.

Valid function keys are f1 through f35, matching KeyCode::FUNCTION_KEY_MAX.

Trait Implementations

impl Clone for ParseKeyError

fn clone(&self) -> ParseKeyError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseKeyError

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

Formats the value using the given formatter.

impl Display for ParseKeyError

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

Formats the value using the given formatter.

impl Eq for ParseKeyError

impl Error for ParseKeyError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for ParseKeyError

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