Struct crokey::KeyEventFormat

pub struct KeyEventFormat {
    pub control: String,
    pub alt: String,
    pub shift: String,
    pub enter: String,
    pub uppercase_shift: bool,
}

A formatter to produce key combinations descriptions.

use {
    crokey::*,
    crossterm::event::{
        KeyCode,
        KeyEvent,
        KeyModifiers,
    },
};

let format = KeyEventFormat::default();
assert_eq!(format.to_string(key!(shift-a)), "Shift-a");
assert_eq!(format.to_string(key!(ctrl-c)), "Ctrl-c");

// A more compact format
let format = KeyEventFormat::default()
    .with_implicit_shift()
    .with_control("^");
assert_eq!(format.to_string(key!(shift-a)), "A");
assert_eq!(format.to_string(key!(ctrl-c)), "^c");

// A long format with lowercased modifiers
let format = KeyEventFormat::default()
    .with_lowercase_modifiers();
assert_eq!(format.to_string(key!(ctrl-enter)), "ctrl-Enter");
assert_eq!(format.to_string(key!(home)), "Home");
assert_eq!(
    format.to_string(
        KeyEvent::new(
            KeyCode::F(6),
            KeyModifiers::ALT,
        )
    ),
    "alt-F6",
);

Fields

control: String

alt: String

shift: String

enter: String

uppercase_shift: bool

Implementations

impl KeyEventFormat

pub fn with_lowercase_modifiers(self) -> Self

pub fn with_control<S: Into<String>>(self, s: S) -> Self

pub fn with_alt<S: Into<String>>(self, s: S) -> Self

pub fn with_shift<S: Into<String>>(self, s: S) -> Self

pub fn with_implicit_shift(self) -> Self

pub fn format(&self, key: KeyEvent) -> FormattedKeyEvent<'_>

return a wrapper of the key implementing Display

use crokey::*;
let format = KeyEventFormat::default();
let k = format.format(key!(f6));
let s = format!("k={}", k);
assert_eq!(s, "k=F6");

pub fn to_string(&self, key: KeyEvent) -> String

return the key formatted into a string

format.to_string(key) is equivalent to format.format(key).to_string().

Trait Implementations

impl Clone for KeyEventFormat

fn clone(&self) -> KeyEventFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEventFormat

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

Formats the value using the given formatter.

impl Default for KeyEventFormat

fn default() -> Self

Returns the “default value” for a type.