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

source

pub fn new() -> Self

New keybining

source

pub fn empty() -> Self

Defines an empty keybinding object

source

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

Adds a keybinding

Panics

If comamnd is an empty ReedlineEvent::UntilFound

source

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

Find a keybinding based on the modifier and keycode

source

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

Remove a keybinding

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

source

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

Get assigned keybindings

Trait Implementations

source

impl Clone for Keybindings

source

fn clone(&self) -> Keybindings

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 Keybindings

source

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

Formats the value using the given formatter. Read more

source

impl Default for Keybindings

source

fn default() -> Self

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

source

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

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Serialize for Keybindings

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. 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> Any for T where
T: 'static + ?Sized,

source

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

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

Performs the conversion.

source

Struct reedline::Keybindings

Fields

Implementations

impl Keybindings

pub fn new() -> Self

pub fn empty() -> Self

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

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

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

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

Trait Implementations

impl Clone for Keybindings

fn clone(&self) -> Keybindings

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

impl Debug for Keybindings

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

impl Default for Keybindings

fn default() -> Self

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl Serialize for Keybindings

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

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

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

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

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,