Struct ShellBinding 

pub struct ShellBinding {
    pub modifier: ShellModifier,
    pub key: ShellKey,
}

A valid shell key binding representation.

Guaranteed at deserialization time to contain only key combinations simple enough to be represented cleanly across all supported shells without fallback defaults: exactly one modifier (ShellModifier::Ctrl or ShellModifier::Alt) and an ASCII character (or space).

Fields

modifier: ShellModifier

The modifier key pressed with the character

key: ShellKey

The key or character pressed with the modifier

Implementations

impl ShellBinding

pub fn new(event: KeyEvent) -> Result<Self, String>

Constructs a new ShellBinding if the KeyEvent meets the representation invariant

pub fn to_key_event(&self) -> KeyEvent

Converts this binding into a crossterm KeyEvent.

pub fn format_key_for_shell(&self, shell: Shell) -> String

Formats the key binding for a specific shell dialect

Trait Implementations

impl Clone for ShellBinding

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShellBinding

impl Debug for ShellBinding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShellBinding

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ShellBinding

impl From<ShellBinding> for KeyEvent

fn from(binding: ShellBinding) -> Self

Converts to this type from the input type.

impl PartialEq for ShellBinding

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ShellBinding