Struct ModalMachine

pub struct ModalMachine<Key: InputKey, S: Step<Key>> { /* private fields */ }

Manage and process modal keybindings.

Implementations

impl<Key, S> ModalMachine<Key, S>

where Key: InputKey, S: Step<Key>, S::State: Default,

pub fn empty() -> Self

Return a new instance without any bindings.

pub fn from_bindings<B: InputBindings<Key, S> + Default>() -> Self

Return an instance that contains default bindings provided by B.

impl<Key, S> ModalMachine<Key, S>

where Key: InputKey, S: Step<Key>,

pub fn from_state(state: S::State) -> Self

Return a new instance using an already initialized state.

pub fn add_prefix( &mut self, mode: S::M, evs: &EdgePath<Key, S::Class>, action: &Option<S>, )

Prefix a mode with the key sequence described by EdgePath.

pub fn add_mapping( &mut self, mode: S::M, evs: &EdgePath<Key, S::Class>, action: &S, )

Map a sequence of keys to an action in the given mode.

pub fn execute(&mut self, input: Vec<Key>) -> InputIterator<'_, Key, S>

Process multiple input keys.

pub fn execute_macro( &mut self, mstr: &str, count: usize, ) -> Result<InputIterator<'_, Key, S>, Key::Error>

Interpret the given string as a macro, and process the keys it represents a given number of times.

pub fn mode(&self) -> S::M

Returns the mode we’ve most recently entered.

Modes reached via Fallthrough will not change what this returns.

pub fn state(&mut self) -> &mut S::State

Get a mutable reference to the keybinding state.

Trait Implementations

impl<Key, S> BindingMachine<Key, <S as Step<Key>>::A, <S as Step<Key>>::Sequence, <<S as Step<Key>>::State as InputState>::Output> for ModalMachine<Key, S>

where Key: InputKey, S: Step<Key>,

fn input_key(&mut self, input: Key)

Process a typed key.

fn pop(&mut self) -> Option<(S::A, <S::State as InputState>::Output)>

Fetch the next action produced by previously typed keys.

fn context(&mut self) -> <S::State as InputState>::Output

Get current output context after the most recent keypress.

fn show_dialog(&mut self, max_rows: usize, max_cols: usize) -> Vec<Cow<'_, str>>

Returns the message to display for the current interactive dialog, if there is one.

fn show_mode(&self) -> Option<String>

Returns a user-friendly string to display for the current mode.

fn get_cursor_indicator(&self) -> Option<char>

Returns a character to show for the cursor.

fn repeat( &mut self, seq: S::Sequence, ctx: Option<<S::State as InputState>::Output>, )

Repeat a recent sequence of tracked actions, and optionally override their original contexts using InputState::merge. The repeated sequence will be inserted at the beginning of the action queue, before any other pending actions.

fn run_dialog(&mut self, dialog: Box<dyn Dialog<S::A>>)

Start an interactive user dialog.