Struct VimState

pub struct VimState<I: ApplicationInfo = EmptyInfo> { /* private fields */ }

This wraps both action specific context, and persistent context.

Trait Implementations

impl<I: ApplicationInfo> Clone for VimState<I>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug + ApplicationInfo> Debug for VimState<I>

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

Formats the value using the given formatter.

impl<I: ApplicationInfo> Default for VimState<I>

fn default() -> Self

Returns the “default value” for a type.

impl<I: ApplicationInfo> From<VimState<I>> for EditContext

fn from(ctx: VimState<I>) -> Self

Converts to this type from the input type.

impl<I: ApplicationInfo> InputKeyState<TerminalKey, CommonKeyClass> for VimState<I>

fn event( &mut self, ev: &EdgeEvent<TerminalKey, CommonKeyClass>, ke: &TerminalKey, )

Update the context as needed after a Key has matched an EdgeEvent.

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

Return a character to show at the current cursor position.

impl<I: ApplicationInfo> InputState for VimState<I>

type Output = EditContext

The output context type returned along with actions.

fn merge(original: EditContext, overrides: &EditContext) -> EditContext

Copy any overriding values into an Output object.

fn reset(&mut self)

Reset any action-specific state.

fn take(&mut self) -> Self::Output

Return a copy of the InputState, and reset any action-specific state.

impl<I: ApplicationInfo> Mode<Action<I>, VimState<I>> for VimMode

fn enter(&self, prev: Self, ctx: &mut VimState<I>) -> Vec<Action<I>>

Perform any necessary updates when entering a new mode.

fn show(&self, ctx: &VimState<I>) -> Option<String>

Return a string to show on-screen that describes the current mode.

impl<I: ApplicationInfo> ModeKeys<TerminalKey, Action<I>, VimState<I>> for VimMode

fn unmapped( &self, ke: &TerminalKey, ctx: &mut VimState<I>, ) -> (Vec<Action<I>>, Option<Self>)

Return the default behaviour for the current mode when the given key is unmapped.

impl<I: ApplicationInfo> ModeSequence<RepeatType, Action<I>, VimState<I>> for VimMode

fn sequences( &self, action: &Action<I>, ctx: &EditContext, ) -> Vec<(RepeatType, SequenceStatus)>

Controls how and what gets included in the sequences of actions tracked by ModalMachine. When implementing, if there are actions that trigger calls to BindingMachine::repeat, be careful that they do not get included in a way that can create cycles.

impl<I: PartialEq + ApplicationInfo> PartialEq for VimState<I>

fn eq(&self, other: &VimState<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: Eq + ApplicationInfo> Eq for VimState<I>

impl<I: ApplicationInfo> StructuralPartialEq for VimState<I>