Struct Keymap 

pub struct Keymap {
    pub first: [Option<Thingy>; 256],
    pub multi: HashMap<Vec<u8>, KeyBinding>,
    pub primary: Option<String>,
    pub flags: i32,
    pub rc: i32,
}

Direct port of struct keymap from Src/Zle/zle_keymap.c:64. A keymap — binding of keys to thingies.

Fields

first: [Option<Thingy>; 256]

Thingy first[256] — c:65, base binding for each byte.

multi: HashMap<Vec<u8>, KeyBinding>

HashTable multi — c:66, multi-character bindings.

primary: Option<String>

KeymapName primary — c:78, primary alias for this map.

flags: i32

int flags — c:79 (KM_IMMUTABLE).

rc: i32

int rc — c:80, reference count (refkeymap/unrefkeymap/ deletekeymap).

Implementations

impl Keymap

pub fn new() -> Keymap

Construct an empty keymap with no bindings. Equivalent to newkeytab() from Src/Zle/zle_keymap.c:278 — the C source allocates a Keymap with the first[] array zeroed out and an empty multi-byte hashtab.

pub fn bind_char(&mut self, c: u8, thingy: Thingy)

Bind a 1-byte key to a Thingy via the first[] fast-path table. Direct port of the single-byte path in bindkey() at Src/Zle/zle_keymap.c:566; the C source writes into km->first[c] when seq has length 1.

pub fn unbind_char(&mut self, c: u8)

Clear a 1-byte binding. Equivalent to bindkey -r against a single-byte sequence at Src/Zle/zle_keymap.c:566 — flips the first[c] slot to None.

pub fn bind_seq(&mut self, seq: &[u8], thingy: Thingy)

Install a multi-byte key sequence binding. Direct port of bindkey(Keymap km, const char *seq, Thingy bind, char *str) from Src/Zle/zle_keymap.c:566 for the len > 1 path: marks every proper prefix of seq as a prefix node (prefixct increment) so getkeymapcmd’s trie walk knows to keep reading bytes when it sees a partial match.

pub fn bind_str(&mut self, seq: &[u8], s: String)

Install a multi-byte key sequence that maps to a literal string. Port of the send-string variant of bindkey() at Src/Zle/zle_keymap.c:566 — the C source stores str instead of a Thingy when invoked via bindkey -s 'seq' 'string'. When the trie hits this entry, getkeycmd ungets the string via ungetbytes_unmeta (zle_keymap.c:1784) so it gets re-resolved against the keymap.

pub fn unbind_seq(&mut self, seq: &[u8])

Remove a multi-byte binding and decrement prefix counts on its ancestors so the trie shrinks correctly. Port of bindkey -r against a multi-byte sequence at Src/Zle/zle_keymap.c:566 — the C source mirrors the prefix reference-count machinery via the same prefixct decrement pattern when removing a leaf.

pub fn lookup_char(&self, c: u8) -> Option<&Thingy>

Fast-path single-byte lookup through first[]. Equivalent to the 1-byte branch of keybind() at Src/Zle/zle_keymap.c:659 — the C source’s km->first[*seq] access for single-byte resolution.

pub fn lookup_seq(&self, seq: &[u8]) -> Option<&KeyBinding>

Multi-byte sequence lookup through the multi hashtab. Equivalent to the >1-byte branch of keybind() at zle_keymap.c:659 — returns the KeyBinding entry if seq matches a leaf, or one carrying prefixct > 0 if seq is a prefix of one or more bound sequences.

pub fn is_prefix(&self, seq: &[u8]) -> bool

Test whether seq is a prefix of any bound sequence. Equivalent to keyisprefix() from Src/Zle/zle_keymap.c. Used by getkeymapcmd to decide whether to keep reading bytes during a multi-byte sequence resolve (the trie-walk loop at zle_keymap.c:1604).

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<(), Error>

Formats the value using the given formatter.

impl Default for Keymap

fn default() -> Keymap

Returns the “default value” for a type.