Enum PromptType 

pub enum PromptType {
    OpenFile,
    OpenFileWithEncoding {
        path: PathBuf,
    },
    ReloadWithEncoding,
    SwitchProject,
    SaveFileAs,
    Search,
    ReplaceSearch,
    Replace {
        search: String,
    },
    QueryReplaceSearch,
    QueryReplace {
        search: String,
    },
    QueryReplaceConfirm,
    Command,
    QuickOpen,
    GotoLine,
    GotoByteOffset,
    GotoLineScanConfirm,
    SetBackgroundFile,
    SetBackgroundBlend,
    Plugin {
        custom_type: String,
    },
    LspRename {
        original_text: String,
        start_pos: usize,
        end_pos: usize,
        overlay_handle: OverlayHandle,
    },
    RecordMacro,
    PlayMacro,
    SetBookmark,
    JumpToBookmark,
    SetPageWidth,
    AddRuler,
    RemoveRuler,
    SetTabSize,
    SetLineEnding,
    SetEncoding,
    SetLanguage,
    StopLspServer,
    RestartLspServer,
    SelectTheme {
        original_theme: String,
    },
    SelectKeybindingMap,
    SelectCursorStyle,
    SelectLocale,
    CopyWithFormattingTheme,
    ConfirmRevert,
    ConfirmSaveConflict,
    ConfirmSudoSave {
        info: SudoSaveRequired,
    },
    ConfirmOverwriteFile {
        path: PathBuf,
    },
    ConfirmCloseBuffer {
        buffer_id: BufferId,
    },
    ConfirmQuitWithModified,
    FileExplorerRename {
        original_path: PathBuf,
        original_name: String,
        is_new_file: bool,
    },
    ConfirmDeleteFile {
        path: PathBuf,
        is_dir: bool,
    },
    ConfirmLargeFileEncoding {
        path: PathBuf,
    },
    SwitchToTab,
    ShellCommand {
        replace: bool,
    },
    AsyncPrompt,
}

Type of prompt - determines what action to take when user confirms

Variants

OpenFile

Open a file

OpenFileWithEncoding

Open a file with a specific encoding (used when detect_encoding is disabled) Contains the path to open after encoding selection

Fields

path: PathBuf

ReloadWithEncoding

Reload current file with a different encoding Requires the buffer to have no unsaved modifications

SwitchProject

Switch to a different project folder (change working directory)

SaveFileAs

Save current buffer to a new file

Search

Search for text in buffer

ReplaceSearch

Search for text in buffer (for replace operation - will prompt for replacement after)

Replace

Replace text in buffer

Fields

search: String

QueryReplaceSearch

Search for text in buffer (for query-replace - will prompt for replacement after)

QueryReplace

Query replace text in buffer - prompt for replacement text

Fields

search: String

QueryReplaceConfirm

Query replace confirmation prompt (y/n/!/q for each match)

Command

Execute a command by name (M-x)

QuickOpen

Quick Open - unified prompt with prefix-based provider routing Supports file finding (default), commands (>), buffers (#), goto line (:)

GotoLine

Go to a specific line number

GotoByteOffset

Go to a specific byte offset (large file without line index scan)

GotoLineScanConfirm

Confirm whether to scan a large file for exact line numbers before Go To Line

SetBackgroundFile

Choose an ANSI background file

SetBackgroundBlend

Set background blend ratio (0-1)

Plugin

Plugin-controlled prompt with custom type identifier The string identifier is used to filter hooks in plugin code

Fields

custom_type: String

LspRename

LSP Rename operation Stores the original text, start/end positions in buffer, and overlay handle

Fields

original_text: String

start_pos: usize

end_pos: usize

overlay_handle: OverlayHandle

RecordMacro

Record a macro - prompts for register (0-9)

PlayMacro

Play a macro - prompts for register (0-9)

SetBookmark

Set a bookmark - prompts for register (0-9)

JumpToBookmark

Jump to a bookmark - prompts for register (0-9)

SetPageWidth

Set page width (empty clears to viewport)

AddRuler

Add a vertical ruler at a column position

RemoveRuler

Remove a vertical ruler (select from list)

SetTabSize

Set tab size for current buffer

SetLineEnding

Set line ending format for current buffer

SetEncoding

Set text encoding format for current buffer

SetLanguage

Set language/syntax highlighting for current buffer

StopLspServer

Stop a running LSP server (select from list)

RestartLspServer

Restart LSP server(s) (select from list)

SelectTheme

Select a theme (select from list) Stores the original theme name for restoration on cancel

Fields

original_theme: String

SelectKeybindingMap

Select a keybinding map (select from list)

SelectCursorStyle

Select a cursor style (select from list)

SelectLocale

Select a UI locale/language (select from list)

CopyWithFormattingTheme

Select a theme for copy with formatting

ConfirmRevert

Confirm reverting a modified file

ConfirmSaveConflict

Confirm saving over a file that changed on disk

ConfirmSudoSave

Confirm saving with sudo after permission denied

Fields

info: SudoSaveRequired

ConfirmOverwriteFile

Confirm overwriting an existing file during SaveAs

Fields

path: PathBuf

ConfirmCloseBuffer

Confirm closing a modified buffer (save/discard/cancel) Stores buffer_id to close after user confirms

Fields

buffer_id: BufferId

ConfirmQuitWithModified

Confirm quitting with modified buffers

FileExplorerRename

File Explorer rename operation Stores the original path and name for the file/directory being renamed

Fields

original_path: PathBuf

original_name: String

is_new_file: bool

True if this rename is for a newly created file (should switch focus to editor after) False if renaming an existing file (should keep focus in file explorer)

ConfirmDeleteFile

Confirm deleting a file or directory in the file explorer

Fields

path: PathBuf

is_dir: bool

ConfirmLargeFileEncoding

Confirm loading a large file with non-resynchronizable encoding (like GB18030, GBK, Shift-JIS, EUC-KR) that requires full file loading

Fields

path: PathBuf

SwitchToTab

Switch to a tab by name (from the current split’s open buffers)

ShellCommand

Run shell command on buffer/selection If replace is true, replace the input with the output If replace is false, output goes to a new buffer

Fields

replace: bool

AsyncPrompt

Async prompt from plugin (for editor.prompt() API) The result is returned via callback resolution

Trait Implementations

impl Clone for PromptType

fn clone(&self) -> PromptType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptType

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

Formats the value using the given formatter.

impl PartialEq for PromptType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PromptType