Skip to main content

VimInsertResolver

Struct VimInsertResolver 

Source
pub struct VimInsertResolver { /* private fields */ }
Expand description

Vim insert mode key resolver.

Insert mode is primarily for text input:

  • Most printable characters are inserted directly
  • Escape exits to normal mode
  • Some control sequences trigger commands (Ctrl+H for backspace, etc.)
  • Arrow keys and special keys are handled via keymap lookup

§Example

let resolver = VimInsertResolver::new();

// Regular character - insert it
let result = resolver.resolve(&key('a'), &mut state);
assert!(matches!(result, ResolveResult::InsertChar('a')));

// Escape - exit to normal mode
let result = resolver.resolve(&KeyEvent::new(KeyCode::Escape), &mut state);
assert!(matches!(result, ResolveResult::ModeTransition(..)));

Implementations§

Source§

impl VimInsertResolver

Source

pub const fn new() -> Self

Create a new insert mode resolver.

Trait Implementations§

Source§

impl Default for VimInsertResolver

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl ModeKeyResolver for VimInsertResolver

Source§

fn resolve_with_keymap( &self, key: &KeyEvent, _state: &mut ModeState, input: &ResolveInput<'_>, ) -> ResolveResult

Insert mode key resolution with keymap lookup.

This method handles keymap lookup for non-insertable keys like Escape, Backspace, and arrow keys. When a key is not insertable, we query the keymap to find a bound command.

§Architecture

Insert mode differs from normal mode:

  • Insertable characters (letters, numbers, etc.) return InsertChar
  • Non-insertable keys (Escape, Backspace, arrows) query the keymap

This enables Escape to trigger the vim:exit-insert command, which properly ends undo batching before switching to normal mode.

Source§

fn resolve_with_extensions( &self, key: &KeyEvent, state: &mut ModeState, input: &ResolveInput<'_>, _shared_extensions: &mut ExtensionMap, client_extensions: &mut ExtensionMap, ) -> ResolveResult

Insert mode key resolution with extension tracking for dot repeat.

This method tracks all inserted characters in VimSessionState.insert_buffer for dot repeat support (Epic #465).

Source§

fn mode_id(&self) -> &ModeId

Which mode this resolver handles.
Source§

fn inherits_from(&self) -> Option<&ModeId>

Optional parent mode to try if we return NotHandled. Read more
Source§

fn reset(&mut self)

Reset any internal state (counts, pending keys, etc.). Read more
Source§

fn resolve(&self, _key: &KeyEvent, _state: &mut ModeState) -> ResolveResult

👎Deprecated since 0.9.5:

Override resolve_with_keymap() instead

Process a key event in this mode’s context (legacy API). Read more
Source§

fn resolve_with_session( &self, key: &KeyEvent, state: &mut ModeState, input: &ResolveInput<'_>, _session: &mut dyn SessionApiDyn, shared_extensions: &mut ExtensionMap, client_extensions: &mut ExtensionMap, ) -> ResolveResult

Process a key event with full session API access. Read more
Source§

fn on_command_complete( &self, _session: &mut dyn SessionApiDyn, _shared_extensions: &mut ExtensionMap, _client_extensions: &mut ExtensionMap, ) -> Option<ModeTransition>

Hook called after a command executes successfully. Read more
Source§

fn pending_keys(&self) -> KeySequence

Get the accumulated pending keys for this resolver. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more