Struct Keymap 

pub struct Keymap { /* private fields */ }

Implementations

impl Keymap

pub fn new() -> Self

pub fn leader(&self) -> Option<char>

Configured leader char. None means <leader> references fail to bind.

pub fn set_leader(&mut self, leader: char)

pub fn bind( &mut self, mode: PageMode, keys: &str, action: PageAction, ) -> Result<(), BindError>

Bind a chord sequence to an action in the given mode. Parses keys via parse_keys and resolves <leader> to the configured leader.

pub fn bind_chords( &mut self, mode: PageMode, chords: &[KeyChord], action: PageAction, )

Bind already-parsed chords. Used by the engine when feeding programmatic bindings.

pub fn lookup(&self, mode: PageMode, chords: &[KeyChord]) -> Lookup<'_>

Look up the chord sequence under mode.

pub fn resolve_timeout( &self, mode: PageMode, chords: &[KeyChord], ) -> Option<&PageAction>

Resolve the longest-prefix action along chords — the engine uses this when the ambiguity timeout fires.

pub fn entries(&self, mode: PageMode) -> Vec<(Vec<KeyChord>, PageAction)>

Flatten every binding under mode to (chord_sequence, action) pairs. Order is unspecified — callers that want deterministic output should sort the result. Used by the new-tab page renderer to list the live keymap, including any hot-reloaded user overrides.

pub fn audit_default_bindings( _leader: char, ) -> Vec<(&'static str, &'static str, PageAction)>

Phase 6 a11y audit: enumerate every static default binding as (mode_label, keys, action) rows. Sorted by (mode, keys) so the output is stable; used by --audit-keymap to verify keyboard-only reachability of every PageAction.

leader mirrors Self::default_bindings; the resolved <leader> chord is rendered as the literal character so users can see what they’d type.

pub fn missing_default_bindings() -> Vec<&'static str>

Phase 6 a11y guarantee: every PageAction reachable by a reasonable user is bound to at least one default chord in some mode. Returns the list of unbound action names (debug-format of the unit/parameterised variant) — empty Vec means full coverage.

“Reasonable” here excludes a small allow-list:

• PageAction::TabReorder — currently mouse-only by design
• PageAction::ClearCompletedDownloads — no obvious chord; reachable via :downloads cmdline
• PageAction::EnterMode — variant-of-everything; the specific EnterHintMode/OpenOmnibar/etc. cover the surface
• [PageAction::ScrollUp/ScrollDown ≠ 1] — only the count=1 variants need a default; counts come from the count buffer

pub fn default_bindings(leader: char) -> Self

Default vim-flavoured bindings. leader is the configured leader char (vim default is \). See docs/keymap.md for the full table.

Trait Implementations

impl Clone for Keymap

fn clone(&self) -> Keymap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keymap

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

Formats the value using the given formatter.

impl Default for Keymap

fn default() -> Keymap

Returns the “default value” for a type.