Struct reedline::Keybindings
source · pub struct Keybindings {
pub bindings: HashMap<KeyCombination, ReedlineEvent>,
}
Expand description
Main definition of editor keybindings
Fields§
§bindings: HashMap<KeyCombination, ReedlineEvent>
Defines a keybinding for a reedline event
Implementations§
source§impl Keybindings
impl Keybindings
sourcepub fn add_binding(
&mut self,
modifier: KeyModifiers,
key_code: KeyCode,
command: ReedlineEvent
)
pub fn add_binding( &mut self, modifier: KeyModifiers, key_code: KeyCode, command: ReedlineEvent )
sourcepub fn find_binding(
&self,
modifier: KeyModifiers,
key_code: KeyCode
) -> Option<ReedlineEvent>
pub fn find_binding( &self, modifier: KeyModifiers, key_code: KeyCode ) -> Option<ReedlineEvent>
Find a keybinding based on the modifier and keycode
sourcepub fn remove_binding(
&mut self,
modifier: KeyModifiers,
key_code: KeyCode
) -> Option<ReedlineEvent>
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
sourcepub fn get_keybindings(&self) -> &HashMap<KeyCombination, ReedlineEvent>
pub fn get_keybindings(&self) -> &HashMap<KeyCombination, ReedlineEvent>
Get assigned keybindings
Trait Implementations§
source§impl Clone for Keybindings
impl Clone for Keybindings
source§fn clone(&self) -> Keybindings
fn clone(&self) -> Keybindings
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for Keybindings
impl Debug for Keybindings
source§impl Default for Keybindings
impl Default for Keybindings
source§impl<'de> Deserialize<'de> for Keybindings
impl<'de> Deserialize<'de> for Keybindings
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl RefUnwindSafe for Keybindings
impl Send for Keybindings
impl Sync for Keybindings
impl Unpin for Keybindings
impl UnwindSafe for Keybindings
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more