Enum EditCommand

Source

pub enum EditCommand {
Show 32 variants    Insert {
        offset: usize,
        text: String,
    },
    Delete {
        start: usize,
        length: usize,
    },
    Replace {
        start: usize,
        length: usize,
        text: String,
    },
    ReplaceCoalescingUndo {
        start: usize,
        length: usize,
        text: String,
    },
    ReplaceCoalescingUndoWithSelection {
        start: usize,
        length: usize,
        text: String,
        selection_start: usize,
        selection_end: usize,
    },
    InsertText {
        text: String,
    },
    TypeChar {
        ch: char,
    },
    InsertTab,
    InsertNewline {
        auto_indent: bool,
    },
    Indent,
    Outdent,
    DuplicateLines,
    DeleteLines,
    MoveLinesUp,
    MoveLinesDown,
    JoinLines,
    SplitLine,
    ToggleComment {
        config: CommentConfig,
    },
    ApplyTextEdits {
        edits: Vec<TextEditSpec>,
    },
    ApplySnippet {
        start: usize,
        end: usize,
        snippet: String,
        additional_edits: Vec<TextEditSpec>,
    },
    DeleteToPrevTabStop,
    DeleteGraphemeBack,
    DeleteGraphemeForward,
    DeleteWordBack,
    DeleteWordForward,
    Backspace,
    DeleteForward,
    Undo,
    Redo,
    EndUndoGroup,
    ReplaceCurrent {
        query: String,
        replacement: String,
        options: SearchOptions,
    },
    ReplaceAll {
        query: String,
        replacement: String,
        options: SearchOptions,
    },
}

Expand description

Text editing commands

Variants§

§

Insert

Insert text at the specified position

Fields

§offset: usize

Character offset to insert at.

§text: String

Text to insert.

§

Delete

Delete text in specified range

Fields

§start: usize

Character offset of the deletion start.

§length: usize

Length of the deletion in characters.

§

Replace

Replace text in specified range

Fields

§start: usize

Character offset of the replacement start.

§length: usize

Length of the replaced range in characters.

§text: String

Replacement text.

§

ReplaceCoalescingUndo

Replace text in specified range, requesting undo coalescing when the edit is eligible.

This is primarily useful for UI layers that need to keep IME composition updates and the final commit in one explicitly delimited undo group.

Notes:

Normal typing coalescing is intentionally limited to pure adjacent insertions without newlines.
This explicit composition path may coalesce replacements only when each update replaces the exact range inserted by the previous update and the selection state is continuous.
The caller is expected to explicitly delimit boundaries via EditCommand::EndUndoGroup so eligible IME insertions do not merge with normal typing groups.

Fields

§start: usize

Character offset of the replacement start.

§length: usize

Length of the replaced range in characters.

§text: String

Replacement text.

§

ReplaceCoalescingUndoWithSelection

Like EditCommand::ReplaceCoalescingUndo, but also sets the primary selection/caret.

This is primarily useful for IME composition updates where the host provides a selection range inside the marked (preedit) string while keeping composition updates in one explicitly delimited undo group.

Notes:

selection_start/selection_end are post-edit character offsets (Unicode scalar indices) in the resulting document.
If selection_start == selection_end, the selection is cleared and the caret is moved to selection_end.

Fields

§start: usize

Character offset of the replacement start.

§length: usize

Length of the replaced range in characters.

§text: String

Replacement text.

§selection_start: usize

Selection start (post-edit) in character offsets.

§selection_end: usize

Selection end (post-edit) in character offsets.

§

InsertText

VSCode-like typing/paste: apply to all carets/selections (primary + secondary)

Fields

§text: String

Text to insert/replace at each selection/caret.

§

TypeChar

Type a single character using auto-pairs rules (if enabled).

This is intended for UI “typing” paths (not paste). It supports:

auto-close pairs ((), {}, [], quotes)
skip over existing closing delimiters
wrap selection with pairs (optional)

Fields

§ch: char

The typed character.

§

InsertTab

Insert a tab at each caret (or replace each selection), using the current tab settings.

If TabKeyBehavior::Tab, inserts '\t'.
If TabKeyBehavior::Spaces, inserts spaces up to the next tab stop.

§

InsertNewline

Insert a newline at each caret (or replace each selection).

If auto_indent is true, the inserted newline is followed by the leading whitespace prefix of the current logical line.

Fields

§auto_indent: bool

Whether to auto-indent the new line.

§

Indent

Indent the selected lines (or the current line for an empty selection).

§

Outdent

Outdent the selected lines (or the current line for an empty selection).

§

DuplicateLines

Duplicate the selected line(s) (or the current line for an empty selection).

This is a line-based operation and will act on all carets/selections (primary + secondary), including rectangular selections.

§

DeleteLines

Delete the selected line(s) (or the current line for an empty selection).

This is a line-based operation and will act on all carets/selections (primary + secondary), including rectangular selections.

§

MoveLinesUp

Move the selected line(s) up by one line.

This is a line-based operation and will act on all carets/selections (primary + secondary), including rectangular selections.

§

MoveLinesDown

Move the selected line(s) down by one line.

This is a line-based operation and will act on all carets/selections (primary + secondary), including rectangular selections.

§

JoinLines

Join the current line with the next line (for each caret/selection).

If multiple carets/selections exist, joins are applied from bottom to top to keep offsets stable.

§

SplitLine

Split the current line at each caret (or replace each selection) by inserting a newline.

This is a convenience alias for EditCommand::InsertNewline with auto_indent: false.

§

ToggleComment

Toggle comments for the selected line(s) or selection ranges, using a language-provided comment configuration.

Fields

§config: CommentConfig

Comment tokens/config for the current language (data-driven).

§

ApplyTextEdits

Apply a batch of text edits as a single undoable step.

Edits are interpreted in pre-edit character offsets.
Edits must be non-overlapping; they are applied in descending offset order internally.

Fields

§edits: Vec<TextEditSpec>

The edit list (character offsets, half-open).

§

ApplySnippet

Apply a snippet-shaped insert as a single undoable step.

This is primarily intended for LSP completion items with insertTextFormat == 2.

start/end are interpreted in pre-edit character offsets (half-open).
additional_edits are applied in the same undo step (also in pre-edit coordinates).
The snippet is expanded (placeholders removed / defaults inserted), and the first placeholder (lowest index) is selected for navigation via CursorCommand::SnippetNextPlaceholder / CursorCommand::SnippetPrevPlaceholder.