Enum ModalState 

pub enum ModalState {
    Normal,
    Insert,
    Visual(VisualKind),
    Select(VisualKind),
    OperatorPending,
    Command,
    Search(SearchDirection),
    Replace,
    Prompt,
}

The vim modal state of a buffer — which grammar a keystroke is read in.

Buffer-level and orthogonal to major / minor modes (a rust buffer is in exactly one of these at a time; the axes never collapse). Keymap lookups are filtered by it, and Range::Selection defaults from it while Visual is active. Serializable so it can cross the core protocol and be recorded in snapshots.

Variants

Normal

Vim Normal mode: keys are operators, motions and commands. The initial state of every buffer and the target of <Esc>.

Insert

Vim Insert mode: printable keys insert text at the cursor.

Visual(VisualKind)

Vim Visual mode with the given selection shape; the selection is the active region and the default range for operators and ex-commands.

Select(VisualKind)

Vim Select mode (SN.3d). Same selection geometry as Self::Visual (the VisualKind is reused verbatim), but inverted typing semantics: a printable key replaces the whole selection and drops into Insert. See docs/dev/architecture/select-mode.md.

OperatorPending

An operator has been typed and a motion or text object is awaited (d in dw). Repeating the operator key operates linewise on the current line (dd, cc, yy).

Command

The : command line (the *command-line* minibuffer) is focused.

Search(SearchDirection)

The / or ? search line (the *search-line* minibuffer) is focused, searching in the given direction.

Replace

Vim Replace mode (R): printable keys overtype existing characters instead of inserting.

Prompt

A generic one-line minibuffer text prompt is focused (see Effect::OpenPrompt) — distinct from Command/Search because those are tied to the specific *command-line* / *search-line* buffers and their own submit semantics; a prompt’s buffer/label/submit-action varies per invocation.

Implementations

impl ModalState

pub fn is_visual(self) -> bool

Whether this state is currently consuming a Visual-mode selection (in any of charwise / linewise / blockwise). Used by callers that want to supply Range::Selection as a default when no explicit range is given.

pub fn is_select(self) -> bool

Whether this state is Select mode (SN.3d), in any of charwise / linewise / blockwise. Select shares Visual’s selection geometry but overtypes on a printable key. Kept distinct from Self::is_visual because the dispatch differs; callers that care only about “is a selection live” should gain an explicit selection_is_active helper when one is first needed (no production caller exists yet — see select-mode.md §2).

pub fn is_operator_pending(self) -> bool

Whether this state expects more input to complete a pending operator. In Op-Pending, a motion or text object is awaited; pressing an operator key here resolves to “operate on the current line” (vim’s dd, cc, yy semantics).

Trait Implementations

impl Clone for ModalState

fn clone(&self) -> ModalState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModalState

impl Debug for ModalState

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

Formats the value using the given formatter.

impl Default for ModalState

fn default() -> ModalState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModalState

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModalState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModalState

impl Hash for ModalState

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ModalState

fn eq(&self, other: &ModalState) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ModalState

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModalState

impl WitBoundary for ModalState

type Wit = ModalState

The generated WIT mirror type.

fn to_wit(&self) -> Result<ModalState, String>

Project the native value into its owned WIT mirror.

fn from_wit(w: ModalState) -> Result<ModalState, String>

Reconstruct the native value from its WIT mirror.