Struct TerminalKey

pub struct TerminalKey { /* private fields */ }

A key pressed in a terminal.

It’s important to remember when setting up keybindings and building a TUI that some terminals represent several keypresses the same way by default, while others are capable of precisely representing what keys the user actually pressed, such as when using something like crossterm::event::PushKeyboardEnhancementFlags or when running in Windows terminal.

For example, if you’re using crossterm::event::KeyCode then you’ll likely run into the following in a Unix terminal:

• <C-M> will sometimes be represented as <Enter>
• <C-I> will sometimes be represented as <Tab>
• <C-?> will sometimes be represented as <BackSpace>
• <C-@> will sometimes be represented as <C-Space>
• <C-[> will sometimes be represented as <Esc>
• <C-\> will sometimes be represented as <C-4>
• <C-]> will sometimes be represented as <C-5>
• <C-^> will sometimes be represented as <C-6>
• <C-_> will sometimes be represented as <C-7>

You can avoid getting bit by differences between terminals by mapping all of these to the same action for consistency.

Additionally, some modifier keys can’t be expressed by default: <S-Enter> or <C-Enter> cannot always be represented. If you map those, make sure you also provide alternatives!

Implementations

impl TerminalKey

pub fn get_literal_char(&self) -> Option<char>

Return this key’s representation as a single codepoint, if it exists.

Trait Implementations

impl Clone for TerminalKey

fn clone(&self) -> TerminalKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalKey

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

Formats the value using the given formatter.

impl Display for TerminalKey

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

Formats the value using the given formatter.

impl From<KeyCode> for TerminalKey

fn from(code: KeyCode) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for TerminalKey

fn from(ke: KeyEvent) -> Self

Converts to this type from the input type.

impl FromStr for TerminalKey

type Err = MacroError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TerminalKey

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<I: ApplicationInfo> InputBindings<TerminalKey, InputStep<I>> for EmacsBindings<I>

fn setup(&self, machine: &mut EmacsMachine<TerminalKey, I>)

Add new bindings to a ModalMachine instance.

impl<I: ApplicationInfo> InputBindings<TerminalKey, InputStep<I>> for VimBindings<I>

fn setup(&self, machine: &mut VimMachine<TerminalKey, I>)

Add new bindings to a ModalMachine instance.

impl InputKey for TerminalKey

type Error = MacroError

The error type returned when parsing a macro string fails.

fn decompose(&mut self) -> Option<Self>

If the input that produced this key could possibly represent two keys, split out the first key.

fn from_macro_str(input: &str) -> Result<Vec<Self>, MacroError>

Parse a string representing a series of keypresses.

fn get_char(&self) -> Option<char>

Return this key’s representation as a single, printable codepoint, if it exists.

impl InputKeyClass<TerminalKey> for CommonKeyClass

fn memberships(ke: &TerminalKey) -> Vec<Self>

Return the classes that the InputKey belongs to.

impl<I: ApplicationInfo> InputKeyState<TerminalKey, CommonKeyClass> for EmacsState<I>

fn event( &mut self, ev: &EdgeEvent<TerminalKey, CommonKeyClass>, ke: &TerminalKey, )

Update the context as needed after a Key has matched an EdgeEvent.

fn get_cursor_indicator(&self) -> Option<char>

Return a character to show at the current cursor position.

impl<I: ApplicationInfo> InputKeyState<TerminalKey, CommonKeyClass> for VimState<I>

fn event( &mut self, ev: &EdgeEvent<TerminalKey, CommonKeyClass>, ke: &TerminalKey, )

Update the context as needed after a Key has matched an EdgeEvent.

fn get_cursor_indicator(&self) -> Option<char>

Return a character to show at the current cursor position.

impl<I: ApplicationInfo> ModeKeys<TerminalKey, Action<I>, EmacsState<I>> for EmacsMode

fn unmapped( &self, ke: &TerminalKey, ctx: &mut EmacsState<I>, ) -> (Vec<Action<I>>, Option<Self>)

Return the default behaviour for the current mode when the given key is unmapped.

impl<I: ApplicationInfo> ModeKeys<TerminalKey, Action<I>, VimState<I>> for VimMode

fn unmapped( &self, ke: &TerminalKey, ctx: &mut VimState<I>, ) -> (Vec<Action<I>>, Option<Self>)

Return the default behaviour for the current mode when the given key is unmapped.

impl PartialEq for TerminalKey

fn eq(&self, other: &TerminalKey) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<I: ApplicationInfo> Step<TerminalKey> for InputStep<I>

type A = Action<I>

The type of output action produced after input.

type State = EmacsState<I>

A context object for managing state that accompanies actions.

type M = EmacsMode

The possible modes for mapping keys.

type Class = CommonKeyClass

Classes of input keys.

type Sequence = RepeatType

A key type for identifying tracked action sequences which can be later repeated.

fn is_unmapped(&self) -> bool

Indicates whether this step should be treated as if it’s an unmapped key, and reset to the root of the current mode.

fn fallthrough(&self) -> Option<Self::M>

Indicate a mode to fall through to when there is no other valid edge.

fn step(&self, ctx: &mut EmacsState<I>) -> (Vec<Action<I>>, Option<Self::M>)

Called once the bindings that lead to this Step have been pressed.

impl<I: ApplicationInfo> Step<TerminalKey> for InputStep<I>

type A = Action<I>

The type of output action produced after input.

type State = VimState<I>

A context object for managing state that accompanies actions.

type Class = CommonKeyClass

Classes of input keys.

type M = VimMode

The possible modes for mapping keys.

type Sequence = RepeatType

A key type for identifying tracked action sequences which can be later repeated.

fn is_unmapped(&self) -> bool

Indicates whether this step should be treated as if it’s an unmapped key, and reset to the root of the current mode.

fn fallthrough(&self) -> Option<Self::M>

Indicate a mode to fall through to when there is no other valid edge.

fn step(&self, ctx: &mut VimState<I>) -> (Vec<Action<I>>, Option<Self::M>)

Called once the bindings that lead to this Step have been pressed.

impl Copy for TerminalKey

impl Eq for TerminalKey

impl StructuralPartialEq for TerminalKey