Struct EditorConfig 

pub struct EditorConfig {

    pub line_numbers: bool,
    pub relative_line_numbers: bool,
    pub line_wrap: bool,
    pub syntax_highlighting: bool,
    pub show_menu_bar: bool,
    pub show_tab_bar: bool,
    pub use_terminal_bg: bool,
    pub cursor_style: CursorStyle,
    pub tab_size: usize,
    pub auto_indent: 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 quick_suggestions: bool,
    pub quick_suggestions_delay_ms: u64,
    pub suggest_on_trigger_characters: bool,
    pub accept_suggestion_on_enter: AcceptSuggestionOnEnter,
    pub enable_inlay_hints: bool,
    pub enable_semantic_tokens_full: bool,
    pub mouse_hover_enabled: bool,
    pub mouse_hover_delay_ms: u64,
    pub double_click_time_ms: u64,
    pub recovery_enabled: bool,
    pub auto_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 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

line_wrap: bool

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

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

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

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

tab_size: usize

Number of spaces per tab character

auto_indent: bool

Automatically indent new lines based on the previous line

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

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 ::). 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: 10 (matches VS Code)

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

accept_suggestion_on_enter: AcceptSuggestionOnEnter

Controls whether pressing Enter accepts the selected completion.

• “on”: Enter always accepts the completion
• “off”: Enter inserts a newline (use Tab to accept)
• “smart”: Enter accepts only if the completion text differs from typed text Default: “on”

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).

mouse_hover_enabled: bool

Whether mouse hover triggers LSP hover requests. When enabled, hovering over code with the mouse will show documentation. Default: true

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

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_save_interval_secs: u32

Auto-save interval in seconds for file recovery Modified buffers are saved to recovery files at this interval. Default: 2 seconds for fast recovery with minimal data loss. Set to 0 to disable periodic auto-save (manual recovery only).

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.

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.