Crate viks

Source
Expand description

viks is parser for vim-like key sequence.
e.g. the *noremap line has unique keymap syntax in .vimrc.

This crate is implmentation for that syntax parsing.

§Example

use viks::Key;
use viks::Keymap;

let shift_a_key = Key::new("A").unwrap();
let shift_a_key_alt = Key::new("<s-a>").unwrap();

assert_eq!(shift_a_key, shift_a_key_alt);

let exit_map = Keymap::new("ZZ").unwrap();
let exit_map_alt = Keymap::new("<s-z>Z").unwrap();

assert_eq!(exit_map, exit_map_alt);
§Dynamic reading
use viks::Keymap;

// replace to some dynamic reading
let line = "<c-b>jj";

if let Ok(map) = Keymap::new(line) {
    // ..
}

Modules§

serde_impl
Serde implemetations.

Structs§

Error
viks error type.
Key
Minimum unit to use for parsing.
Keymap
Wrapper of Vec<Key>.

Type Aliases§

Result
viks result alias.