Struct crokey::KeyEventFormat

source · [−]

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

Expand description

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: Stringalt: Stringshift: Stringenter: Stringuppercase_shift: bool

Implementations

source

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");

source

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

source

impl Clone for KeyEventFormat

source

fn clone(&self) -> KeyEventFormat

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for KeyEventFormat

source

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

Formats the value using the given formatter. Read more

source

impl Default for KeyEventFormat

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for KeyEventFormat

impl Send for KeyEventFormat

impl Sync for KeyEventFormat

impl Unpin for KeyEventFormat

impl UnwindSafe for KeyEventFormat

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct crokey::KeyEventFormat

Fields

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<'_>

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

Trait Implementations

impl Clone for KeyEventFormat

fn clone(&self) -> KeyEventFormat

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

impl Debug for KeyEventFormat

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

impl Default for KeyEventFormat

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for KeyEventFormat

impl Send for KeyEventFormat

impl Sync for KeyEventFormat

impl Unpin for KeyEventFormat

impl UnwindSafe for KeyEventFormat

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,