KeyMap

Struct KeyMap 

Source
pub struct KeyMap { /* private fields */ }
Expand description

Configurable key-to-action bindings

KeyMap provides a mapping from KeyInput to Action, allowing users to customize key bindings without modifying behavior.

§Examples

use fast_fs::nav::{KeyMap, KeyInput, Action};

// Start with default bindings
let mut keymap = KeyMap::default();

// Customize: use Delete key for delete action
keymap.unbind(&KeyInput::Char('d'));
keymap.bind(KeyInput::Delete, Action::Delete);

// Or start empty and add only what you need
let mut minimal = KeyMap::empty();
minimal.bind(KeyInput::Up, Action::MoveUp);
minimal.bind(KeyInput::Down, Action::MoveDown);
minimal.bind(KeyInput::Enter, Action::Enter);

Implementations§

Source§

impl KeyMap

Source

pub fn empty() -> Self

Create an empty keymap with no bindings

Source

pub fn bind(&mut self, key: KeyInput, action: Action)

Bind a key to an action

If the key was already bound, the previous binding is replaced.

Source

pub fn unbind(&mut self, key: &KeyInput)

Remove a key binding

Source

pub fn get(&self, key: &KeyInput) -> Option<Action>

Get the action bound to a key, if any

Source

pub fn is_bound(&self, key: &KeyInput) -> bool

Check if a key has a binding

Source

pub fn bindings(&self) -> impl Iterator<Item = (&KeyInput, &Action)>

Get all bindings as an iterator

Source

pub fn len(&self) -> usize

Get the number of bindings

Source

pub fn is_empty(&self) -> bool

Check if the keymap is empty

Source

pub fn keys_for(&self, action: Action) -> Vec<&KeyInput>

Find all keys bound to a specific action

Trait Implementations§

Source§

impl Clone for KeyMap

Source§

fn clone(&self) -> KeyMap

Returns a duplicate 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 KeyMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KeyMap

Source§

fn default() -> Self

Create a keymap with default vim-style bindings

Auto Trait Implementations§

§

impl Freeze for KeyMap

§

impl RefUnwindSafe for KeyMap

§

impl Send for KeyMap

§

impl Sync for KeyMap

§

impl Unpin for KeyMap

§

impl UnwindSafe for KeyMap

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.