Struct termwiz::keymap::KeyMap

pub struct KeyMap<Value: Debug + Clone> { /* private fields */ }

The KeyMap struct is intended to hold the text sequences generated by unix terminal programs. Those sequences have overlapping/ambiguous meaning which requires having more data to correctly interpret the sequence. The lookup operation returns an enum describing the confidence of a match rather than a simple map lookup.

Implementations

impl<Value: Debug + Clone> KeyMap<Value>

pub fn new() -> Self

pub fn insert<K: AsRef<[u8]>>(&mut self, key: K, value: Value)

Insert a value into the keymap

pub fn lookup<S: AsRef<[u8]>>(&self, key: S) -> Found<Value>

Perform a lookup for key. key can be a string consisting of a sequence of bytes. The lookup operation considers the prefix of key and searches for a match.

If Found::None is returned then the prefix for key has no matching keymap entry.

If Found::Exact is returned then the returned value informs the caller of the length of the key that was matched; the remainder of the key was not considered and is something that should be considered again in a subsequent lookup operation.

If Found::Ambiguous is returned then the key matched a valid entry (which is returned as the value), but there is at least one other entry that could match if more data were available. If the caller knows that no more data is available immediately then it may be valid to treat this result as equivalent to Found::Exact. The intended use for this variant is to handle the case where a sequence straddles a buffer boundary (eg: fixed size buffer receives a partial sequence, and the remainder is immediately available on the next read) without misinterpreting the read data.

If Found::NeedData is returned it indicates that key is too short to determine a match. The purpose is similar to the Found::Ambiguous case; if the caller knows that no more data is available this can be treated as Found::None, but otherwise it would be best to read more data from the stream and retry with a longer input.

Trait Implementations

impl<Value: Clone + Debug + Clone> Clone for KeyMap<Value>

fn clone(&self) -> KeyMap<Value>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Value: Debug + Debug + Clone> Debug for KeyMap<Value>

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

Formats the value using the given formatter.

impl<Value: Debug + Clone> Default for KeyMap<Value>

fn default() -> Self

Returns the “default value” for a type.