pub struct Keymap { /* private fields */ }Expand description
A mapping from key chords to actions (spec §10 defaults, overridable per
action by ui.keybindings).
Implementations§
Source§impl Keymap
impl Keymap
Sourcepub fn action_for(&self, chord: KeyChord) -> Option<KeyAction>
pub fn action_for(&self, chord: KeyChord) -> Option<KeyAction>
Returns the action bound to chord, if any.
Sourcepub fn rebind(&mut self, action: KeyAction, chord: KeyChord)
pub fn rebind(&mut self, action: KeyAction, chord: KeyChord)
Rebinds action to a single chord, replacing all of that action’s
existing bindings (the ui.keybindings override semantics, §11).
Sourcepub fn chords_for(&self, action: KeyAction) -> Vec<KeyChord>
pub fn chords_for(&self, action: KeyAction) -> Vec<KeyChord>
Returns the chords currently bound to action (for help/hints display).
Sourcepub fn display_for(&self, action: KeyAction) -> Option<String>
pub fn display_for(&self, action: KeyAction) -> Option<String>
A stable, human-readable display of every chord bound to action, joined
with / (e.g. ↑/k), or None if the action is currently unbound. The
chords are sorted because Keymap::chords_for draws from a HashMap
whose iteration order is unspecified; without this the displayed hint
would flicker between runs.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Keymap
impl RefUnwindSafe for Keymap
impl Send for Keymap
impl Sync for Keymap
impl Unpin for Keymap
impl UnsafeUnpin for Keymap
impl UnwindSafe for Keymap
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more