Enum ModalState 

pub enum ModalState {
    Normal {
        pending: PendingOp,
    },
    Insert,
    Visual,
    VisualLine,
    Command {
        minibuffer: String,
    },
}

The modal state machine — a SUM over the five editor modes, each carrying ONLY the data valid in that mode.

#[serde(tag = "mode")] keeps the wire shape readable ({"mode": "Normal", "pending": {…}}) and is the parse boundary: a deserialized value can only be one of the legal shapes.

Variants

Normal

Fields

pending: PendingOp

Insert

Visual

VisualLine

Command

Fields

minibuffer: String

Implementations

impl ModalState

pub fn new() -> Self

pub const fn mode(&self) -> Mode

The Mode discriminant of the current state — the projection the renderers + keymap dispatch read.

pub fn enter_normal(&mut self)

Enter Mode::Normal with no pending count/operator.

pub fn enter_insert(&mut self)

Enter Mode::Insert. Any pending count/operator/minibuffer is dropped by construction.

pub fn enter_visual(&mut self)

Enter Mode::Visual.

pub fn enter_visual_line(&mut self)

Enter Mode::VisualLine.

pub fn enter_command(&mut self)

Enter Mode::Command with an empty minibuffer.

pub fn escape(&mut self)

Leave any mode back to a clean Mode::Normal — the <Esc> transition.

pub fn enter(&mut self, mode: Mode)

Dispatch to the matching typed transition for a target Mode.

Kept for callers that hold a runtime Mode value (e.g. the keymap’s Action::ChangeMode(Mode)); it is sugar over the enter_* methods and preserves the invariant the same way.

pub fn set_operator(&mut self, op: Operator)

Set the pending operator. No-op unless in Mode::Normal.

pub fn append_count(&mut self, digit: u32)

Append a digit to the pending count. No-op unless in Mode::Normal.

pub const fn pending_count(&self) -> Option<u32>

The current pending count (None ⇒ none accumulated). Always None outside Mode::Normal.

pub const fn pending_operator(&self) -> Option<Operator>

The current pending operator. Always None outside Mode::Normal.

pub fn consume_count(&mut self) -> u32

Take the pending count, leaving it cleared; defaults to 1 (and at least 1). No-op-returning-1 outside Mode::Normal.

pub fn clear_count(&mut self)

Clear any pending count without consuming its value.

pub fn consume_operator(&mut self) -> Option<Operator>

Take the pending operator, leaving it cleared.

pub fn minibuffer(&self) -> &str

Read the command-mode minibuffer (empty string outside Mode::Command).

pub fn push_minibuffer(&mut self, ch: char)

Push a char onto the minibuffer. No-op unless in Mode::Command.

pub fn pop_minibuffer(&mut self) -> Option<char>

Pop a char off the minibuffer. None unless in Mode::Command.

pub fn push_minibuffer_str(&mut self, s: &str)

Append a raw fragment to the minibuffer (used by the command registry’s __quit__ sentinel handshake). No-op outside Mode::Command.

pub fn clear_minibuffer(&mut self)

Clear the minibuffer in place. No-op outside Mode::Command.

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 Debug for ModalState

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

Formats the value using the given formatter.

impl Default for ModalState

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModalState

impl JsonSchema for ModalState

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModalState