Skip to main content

InsertAt

Enum InsertAt 

Source
pub enum InsertAt {
    Caret,
    FirstNonBlank,
    AfterCaret,
    LineEnd,
    OpenBelow,
    OpenAbove,
}
Expand description

WHERE the caret lands when Insert mode is entered — vim’s insert-entry family (i I a A o O) as ONE typed surface.

Until 2026-08-12 the family was a single key. i was bound straight to Action::ChangeMode(Mode::Insert) and the other five did not exist — pressing A in escriba 0.1.71 moved nothing, changed no mode, and reported nothing, because an unbound Normal-mode key resolves to Action::Pending. The absence was invisible from inside: escriba --keymap lists what IS bound, so nothing named the four keys a vim user reaches for first.

Modelling the ENTRY POINT rather than the destination mode is what makes that class of omission unrepresentable. A new entry is a variant here, and Action::text_effect, Action::highlight_effect, Action::edits_prompt and the runtime’s damage classifier are all total over Action — so adding one cannot compile until every consequence has been decided.

Variants§

§

Caret

i — insert BEFORE the caret. The caret does not move.

§

FirstNonBlank

I — the first non-blank character of the line.

§

AfterCaret

a — one column right of the caret (“append”), clamped to one past the last character so a on the final character still appends.

§

LineEnd

A — one column past the last character of the line.

§

OpenBelow

o — open a fresh line BELOW the caret’s and land on it.

§

OpenAbove

O — open a fresh line ABOVE the caret’s and land on it.

Implementations§

Source§

impl InsertAt

Source

pub const ALL: [Self; 6]

Every entry, so a matrix test cannot silently miss one.

Source

pub const fn opens_a_line(self) -> bool

Does this entry ADD a line to the buffer?

o and O are the only two members of the family that change text; the other four move the caret and nothing else. Read by Action::text_effect, so the answer lives here beside the variants rather than being re-derived by each classifier that needs it.

Source

pub const fn as_str(self) -> &'static str

The stable label — escriba --keymap, the command palette, the rc’s :action names.

Trait Implementations§

Source§

impl Clone for InsertAt

Source§

fn clone(&self) -> InsertAt

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for InsertAt

Source§

impl Debug for InsertAt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for InsertAt

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for InsertAt

Source§

impl JsonSchema for InsertAt

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

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

impl PartialEq for InsertAt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for InsertAt

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for InsertAt

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.