Struct EditorConfig 

pub struct EditorConfig {

    pub line_numbers: bool,
    pub relative_line_numbers: bool,
    pub highlight_current_line: bool,
    pub line_wrap: bool,
    pub wrap_indent: bool,
    pub wrap_column: Option<usize>,
    pub page_width: Option<usize>,
    pub syntax_highlighting: bool,
    pub show_menu_bar: bool,
    pub menu_bar_mnemonics: bool,
    pub show_tab_bar: bool,
    pub show_status_bar: bool,
    pub show_prompt_line: bool,
    pub show_vertical_scrollbar: bool,
    pub show_horizontal_scrollbar: bool,
    pub show_tilde: bool,
    pub use_terminal_bg: bool,
    pub cursor_style: CursorStyle,
    pub rulers: Vec<usize>,
    pub whitespace_show: bool,
    pub whitespace_spaces_leading: bool,
    pub whitespace_spaces_inner: bool,
    pub whitespace_spaces_trailing: bool,
    pub whitespace_tabs_leading: bool,
    pub whitespace_tabs_inner: bool,
    pub whitespace_tabs_trailing: bool,
    pub use_tabs: bool,
    pub tab_size: usize,
    pub auto_indent: bool,
    pub auto_close: bool,
    pub auto_surround: bool,
    pub scroll_offset: usize,
    pub default_line_ending: LineEndingOption,
    pub trim_trailing_whitespace_on_save: bool,
    pub ensure_final_newline_on_save: bool,
    pub highlight_matching_brackets: bool,
    pub rainbow_brackets: bool,
    pub completion_popup_auto_show: bool,
    pub quick_suggestions: bool,
    pub quick_suggestions_delay_ms: u64,
    pub suggest_on_trigger_characters: bool,
    pub enable_inlay_hints: bool,
    pub enable_semantic_tokens_full: bool,
    pub diagnostics_inline_text: bool,
    pub mouse_hover_enabled: bool,
    pub mouse_hover_delay_ms: u64,
    pub double_click_time_ms: u64,
    pub auto_save_enabled: bool,
    pub auto_save_interval_secs: u32,
    pub hot_exit: bool,
    pub recovery_enabled: bool,
    pub auto_recovery_save_interval_secs: u32,
    pub auto_revert_poll_interval_ms: u64,
    pub keyboard_disambiguate_escape_codes: bool,
    pub keyboard_report_event_types: bool,
    pub keyboard_report_alternate_keys: bool,
    pub keyboard_report_all_keys_as_escape_codes: bool,
    pub highlight_timeout_ms: u64,
    pub snapshot_interval: usize,
    pub highlight_context_bytes: usize,
    pub large_file_threshold_bytes: u64,
    pub estimated_line_length: usize,
    pub read_concurrency: usize,
    pub file_tree_poll_interval_ms: u64,
}

Editor behavior configuration

Fields

line_numbers: bool

Show line numbers in the gutter (default for new buffers)

relative_line_numbers: bool

Show line numbers relative to cursor position

highlight_current_line: bool

Highlight the line containing the cursor

line_wrap: bool

Wrap long lines to fit the window width (default for new views)

wrap_indent: bool

Indent wrapped continuation lines to match the leading whitespace of the original line

wrap_column: Option<usize>

Column at which to wrap lines when line wrapping is enabled. If not specified (null), lines wrap at the viewport edge (default behavior). Example: 80 wraps at column 80. The actual wrap column is clamped to the viewport width (lines can’t wrap beyond the visible area).

page_width: Option<usize>

Width of the page in page view mode (in columns). Controls the content width when page view is active, with centering margins. Defaults to 80. Set to null to use the full viewport width.

syntax_highlighting: bool

Enable syntax highlighting for code files

show_menu_bar: bool

Whether the menu bar is visible by default. The menu bar provides access to menus (File, Edit, View, etc.) at the top of the screen. Can be toggled at runtime via command palette or keybinding. Default: true

menu_bar_mnemonics: bool

Whether menu bar mnemonics (Alt+letter shortcuts) are enabled. When enabled, pressing Alt+F opens the File menu, Alt+E opens Edit, etc. Disabling this frees up Alt+letter keybindings for other actions. Default: true

show_tab_bar: bool

Whether the tab bar is visible by default. The tab bar shows open files in each split pane. Can be toggled at runtime via command palette or keybinding. Default: true

show_status_bar: bool

Whether the status bar is visible by default. The status bar shows file info, cursor position, and editor status at the bottom of the screen. Can be toggled at runtime via command palette or keybinding. Default: true

show_prompt_line: bool

Whether the prompt line is visible by default. The prompt line is the bottom-most line used for command input, search, file open, etc. When hidden, the prompt line only appears when a prompt is active. Can be toggled at runtime via command palette or keybinding. Default: true

show_vertical_scrollbar: bool

Whether the vertical scrollbar is visible in each split pane. Can be toggled at runtime via command palette or keybinding. Default: true

show_horizontal_scrollbar: bool

Whether the horizontal scrollbar is visible in each split pane. The horizontal scrollbar appears when line wrap is disabled and content extends beyond the viewport. Can be toggled at runtime via command palette or keybinding. Default: false

show_tilde: bool

Show tilde (~) markers on lines after the end of the file. These vim-style markers indicate lines that are not part of the file content. Default: true

use_terminal_bg: bool

Use the terminal’s default background color instead of the theme’s editor background. When enabled, the editor background inherits from the terminal emulator, allowing transparency or custom terminal backgrounds to show through. Default: false

cursor_style: CursorStyle

Cursor style for the terminal cursor. Options: blinking_block, steady_block, blinking_bar, steady_bar, blinking_underline, steady_underline Default: blinking_block

rulers: Vec<usize>

Vertical ruler lines at specific column positions. Draws subtle vertical lines to help with line length conventions. Example: [80, 120] draws rulers at columns 80 and 120. Default: [] (no rulers)

whitespace_show: bool

Master toggle for whitespace indicator visibility. When disabled, no whitespace indicators (·, →) are shown regardless of the per-position settings below. Default: true

whitespace_spaces_leading: bool

Show space indicators (·) for leading whitespace (indentation). Leading whitespace is everything before the first non-space character on a line. Default: false

whitespace_spaces_inner: bool

Show space indicators (·) for inner whitespace (between words/tokens). Inner whitespace is spaces between the first and last non-space characters. Default: false

whitespace_spaces_trailing: bool

Show space indicators (·) for trailing whitespace. Trailing whitespace is everything after the last non-space character on a line. Default: false

whitespace_tabs_leading: bool

Show tab indicators (→) for leading tabs (indentation). Can be overridden per-language via show_whitespace_tabs in language config. Default: true

whitespace_tabs_inner: bool

Show tab indicators (→) for inner tabs (between words/tokens). Can be overridden per-language via show_whitespace_tabs in language config. Default: true

whitespace_tabs_trailing: bool

Show tab indicators (→) for trailing tabs. Can be overridden per-language via show_whitespace_tabs in language config. Default: true

use_tabs: bool

Whether pressing Tab inserts a tab character instead of spaces. This is the global default; individual languages can override it via their own use_tabs setting. Default: false (insert spaces)

tab_size: usize

Number of spaces per tab character

auto_indent: bool

Automatically indent new lines based on the previous line

auto_close: bool

Automatically close brackets, parentheses, and quotes when typing. When enabled, typing an opening delimiter like (, [, {, ", ', or ` will automatically insert the matching closing delimiter. Also enables skip-over (moving past existing closing delimiters) and pair deletion (deleting both delimiters when backspacing between them). Default: true

auto_surround: bool

Automatically surround selected text with matching pairs when typing an opening delimiter. When enabled and text is selected, typing (, [, {, ", ', or ` wraps the selection instead of replacing it. Default: true

scroll_offset: usize

Minimum lines to keep visible above/below cursor when scrolling

default_line_ending: LineEndingOption

Default line ending format for new files. Files loaded from disk will use their detected line ending format. Options: “lf” (Unix/Linux/macOS), “crlf” (Windows), “cr” (Classic Mac) Default: “lf”

trim_trailing_whitespace_on_save: bool

Remove trailing whitespace from lines when saving. Default: false

ensure_final_newline_on_save: bool

Ensure files end with a newline when saving. Default: false

highlight_matching_brackets: bool

Highlight matching bracket pairs when cursor is on a bracket. Default: true

rainbow_brackets: bool

Use rainbow colors for nested brackets based on nesting depth. Requires highlight_matching_brackets to be enabled. Default: true

completion_popup_auto_show: bool

Automatically show the completion popup while typing. When false (default), the popup only appears when explicitly invoked (e.g. via Ctrl+Space). When true, it appears automatically after a short delay while typing. Default: false

quick_suggestions: bool

Enable quick suggestions (VS Code-like behavior). When enabled, completion suggestions appear automatically while typing, not just on trigger characters (like . or ::). Only takes effect when completion_popup_auto_show is true. Default: true

quick_suggestions_delay_ms: u64

Delay in milliseconds before showing completion suggestions. Lower values (10-50ms) feel more responsive but may be distracting. Higher values (100-500ms) reduce noise while typing. Trigger characters (like .) bypass this delay. Default: 150

suggest_on_trigger_characters: bool

Whether trigger characters (like ., ::, ->) immediately show completions. When true, typing a trigger character bypasses quick_suggestions_delay_ms. Default: true

enable_inlay_hints: bool

Whether to enable LSP inlay hints (type hints, parameter hints, etc.)

enable_semantic_tokens_full: bool

Whether to request full-document LSP semantic tokens. Range requests are still used when supported. Default: false (range-only to avoid heavy full refreshes).

diagnostics_inline_text: bool

Whether to show inline diagnostic text at the end of lines with errors/warnings. When enabled, the highest-severity diagnostic message is rendered after the source code on each affected line. Default: false

mouse_hover_enabled: bool

Whether mouse hover triggers LSP hover requests. When enabled, hovering over code with the mouse will show documentation. On Windows, this also controls the mouse tracking mode: when disabled, the editor uses xterm mode 1002 (cell motion — click, drag, release only); when enabled, it uses mode 1003 (all motion — full mouse movement tracking). Mode 1003 generates high event volume on Windows and may cause input corruption on some systems. On macOS and Linux this setting only controls LSP hover; the mouse tracking mode is always full motion. Default: true (macOS/Linux), false (Windows)

mouse_hover_delay_ms: u64

Delay in milliseconds before a mouse hover triggers an LSP hover request. Lower values show hover info faster but may cause more LSP server load. Default: 500ms

double_click_time_ms: u64

Time window in milliseconds for detecting double-clicks. Two clicks within this time are treated as a double-click (word selection). Default: 500ms

auto_save_enabled: bool

Whether to enable persistent auto-save (save to original file on disk). When enabled, modified buffers are saved to their original file path at a configurable interval. Default: false

auto_save_interval_secs: u32

Interval in seconds for persistent auto-save. Modified buffers are saved to their original file at this interval. Only effective when auto_save_enabled is true. Default: 30 seconds

hot_exit: bool

Whether to preserve unsaved changes in all buffers (file-backed and unnamed) across editor sessions (VS Code “hot exit” behavior). When enabled, modified buffers are backed up on clean exit and their unsaved changes are restored on next startup. Unnamed (scratch) buffers are also persisted (Sublime Text / Notepad++ behavior). Default: true

recovery_enabled: bool

Whether to enable file recovery (Emacs-style auto-save) When enabled, buffers are periodically saved to recovery files so they can be recovered if the editor crashes.

auto_recovery_save_interval_secs: u32

Interval in seconds for auto-recovery-save. Modified buffers are saved to recovery files at this interval. Only effective when recovery_enabled is true. Default: 2 seconds

auto_revert_poll_interval_ms: u64

Poll interval in milliseconds for auto-reverting open buffers. When auto-revert is enabled, file modification times are checked at this interval. Lower values detect external changes faster but use more CPU. Default: 2000ms (2 seconds)

keyboard_disambiguate_escape_codes: bool

Enable keyboard enhancement: disambiguate escape codes using CSI-u sequences. This allows unambiguous reading of Escape and modified keys. Requires terminal support (kitty keyboard protocol). Default: true

keyboard_report_event_types: bool

Enable keyboard enhancement: report key event types (repeat/release). Adds extra events when keys are autorepeated or released. Requires terminal support (kitty keyboard protocol). Default: false

keyboard_report_alternate_keys: bool

Enable keyboard enhancement: report alternate keycodes. Sends alternate keycodes in addition to the base keycode. Requires terminal support (kitty keyboard protocol). Default: true

keyboard_report_all_keys_as_escape_codes: bool

Enable keyboard enhancement: report all keys as escape codes. Represents all keyboard events as CSI-u sequences. Required for repeat/release events on plain-text keys. Requires terminal support (kitty keyboard protocol). Default: false

highlight_timeout_ms: u64

Maximum time in milliseconds for syntax highlighting per frame

snapshot_interval: usize

Undo history snapshot interval (number of edits between snapshots)

highlight_context_bytes: usize

Number of bytes to look back/forward from the viewport for syntax highlighting context. Larger values improve accuracy for multi-line constructs (strings, comments, nested blocks) but may slow down highlighting for very large files. Default: 10KB (10000 bytes)

large_file_threshold_bytes: u64

File size threshold in bytes for “large file” behavior Files larger than this will:

• Skip LSP features
• Use constant-size scrollbar thumb (1 char)

Files smaller will count actual lines for accurate scrollbar rendering

estimated_line_length: usize

Estimated average line length in bytes (used for large file line estimation) This is used by LineIterator to estimate line positions in large files without line metadata. Typical values: 80-120 bytes.

read_concurrency: usize

Maximum number of concurrent filesystem read requests. Used during line-feed scanning and other bulk I/O operations. Higher values improve throughput, especially for remote filesystems. Default: 64

file_tree_poll_interval_ms: u64

Poll interval in milliseconds for refreshing expanded directories in the file explorer. Directory modification times are checked at this interval to detect new/deleted files. Lower values detect changes faster but use more CPU. Default: 3000ms (3 seconds)

Trait Implementations

impl Clone for EditorConfig

fn clone(&self) -> EditorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditorConfig

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

Formats the value using the given formatter.

impl Default for EditorConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EditorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&EditorConfig> for PartialEditorConfig

fn from(cfg: &EditorConfig) -> Self

Converts to this type from the input type.

impl JsonSchema for EditorConfig

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for EditorConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.