Struct reedline::Keybindings

pub struct Keybindings {
    pub bindings: HashMap<KeyCombination, ReedlineEvent>,
}

Main definition of editor keybindings

Fields

bindings: HashMap<KeyCombination, ReedlineEvent>

Defines a keybinding for a reedline event

Implementations

impl Keybindings

pub fn new() -> Self

New keybining

pub fn empty() -> Self

Defines an empty keybinding object

pub fn add_binding( &mut self, modifier: KeyModifiers, key_code: KeyCode, command: ReedlineEvent )

Adds a keybinding

Panics

If command is an empty ReedlineEvent::UntilFound

pub fn find_binding( &self, modifier: KeyModifiers, key_code: KeyCode ) -> Option<ReedlineEvent>

Find a keybinding based on the modifier and keycode

pub fn remove_binding( &mut self, modifier: KeyModifiers, key_code: KeyCode ) -> Option<ReedlineEvent>

Remove a keybinding

Returns Some(ReedlineEvent) if the key combination was previously bound to a particular ReedlineEvent

pub fn get_keybindings(&self) -> &HashMap<KeyCombination, ReedlineEvent>

Get assigned keybindings

Trait Implementations

impl Clone for Keybindings

fn clone(&self) -> Keybindings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Keybindings

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

Formats the value using the given formatter.

impl Default for Keybindings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Keybindings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Keybindings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.