Trait OptionGroup 

pub trait OptionGroup: 'static {
    const NAME: &'static str;
    const DOC: &'static str;

    // Provided method
    fn type_id() -> TypeId
       where Self: Sized { ... }
}

Compile-time declaration of one option group. Each group is a unit struct (typically generated by the crate::groups! macro) implementing this trait.

Required Associated Constants

const NAME: &'static str

Public display name. Used as the boundary string for :customize <name> and as the prefix-match key for option group queries. Cannot end in -mode.

const DOC: &'static str

Doc string. Shown in :describe-group <name> and the :customize group picker.

Provided Methods

fn type_id() -> TypeId

where Self: Sized,

TypeId for type-driven group lookups.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl OptionGroup for Ai

const NAME: &'static str = "ai"

const DOC: &'static str = "AI-agent (ACP client) options: per-process log capture + level."

impl OptionGroup for Appearance

const NAME: &'static str = "appearance"

const DOC: &'static str = "Appearance / theming options (colors, sprite icons, font rendering)."

impl OptionGroup for Completion

const NAME: &'static str = "completion"

const DOC: &'static str = "Completion options across providers (LSP, snippets, buffer-words, paths)."

impl OptionGroup for Diagnostics

const NAME: &'static str = "diagnostics"

const DOC: &'static str = "Diagnostics presentation: inline end-of-line summary scope + min-severity."

impl OptionGroup for Display

const NAME: &'static str = "display"

const DOC: &'static str = "Visual-presentation options across modes \ (line numbers, wrap, whitespace visualization, ...)."

impl OptionGroup for Editing

const NAME: &'static str = "editing"

const DOC: &'static str = "Editing-related options (search, indent, auto-pair, ...)."

impl OptionGroup for Editor

const NAME: &'static str = "editor"

const DOC: &'static str = "Bare-named editor options (tabstop, number, wrap, foldmethod, ...). \ Reserved namespace -- plugins must use their own prefix."

impl OptionGroup for Filetree

const NAME: &'static str = "filetree"

const DOC: &'static str = "File tree navigation buffer."

impl OptionGroup for Help

const NAME: &'static str = "help"

const DOC: &'static str = "Help / documentation buffers."

impl OptionGroup for Lsp

const NAME: &'static str = "lsp"

const DOC: &'static str = "Every option owned by an LSP mode. \ `:customize lsp` shows the union sectioned by owning mode."

impl OptionGroup for Magit

const NAME: &'static str = "magit"

const DOC: &'static str = "Magit git porcelain buffers."

impl OptionGroup for Messages

const NAME: &'static str = "messages"

const DOC: &'static str = "Echo-area + `*messages*` buffer + tracing bridge."

impl OptionGroup for Modeline

const NAME: &'static str = "modeline"

const DOC: &'static str = "Modeline (bottom per-pane status row): per-zone element layout + separator."

impl OptionGroup for Mouse

const NAME: &'static str = "mouse"

const DOC: &'static str = "Mouse reporting: whether the editor captures mouse events from the terminal."

impl OptionGroup for Notifications

const NAME: &'static str = "notifications"

const DOC: &'static str = "Corner-anchored notifications."

impl OptionGroup for Oil

const NAME: &'static str = "oil"

const DOC: &'static str = "Oil-style editable directory buffer."

impl OptionGroup for Pane

const NAME: &'static str = "pane"

const DOC: &'static str = "Per-pane behaviour: the bound on each pane's buffer history trail."

impl OptionGroup for Picker

const NAME: &'static str = "picker"

const DOC: &'static str = "File finder, command palette, symbol search."

impl OptionGroup for Plugin

const NAME: &'static str = "plugin"

const DOC: &'static str = "Plugin observability: the global default boundary-trace verbosity."

impl OptionGroup for Project

const NAME: &'static str = "project"

const DOC: &'static str = "Project resolution: the marker set a buffer's project root is discovered by."

impl OptionGroup for Search

const NAME: &'static str = "search"

const DOC: &'static str = "Project-search options: `:search` clustering, context lines, scan limits."

impl OptionGroup for Snippet

const NAME: &'static str = "snippet"

const DOC: &'static str = "Snippet engine: activation policy + supported-language allowlist."

impl OptionGroup for Tabline

const NAME: &'static str = "tabline"

const DOC: &'static str = "Tabline (vim-style tab strip)."

impl OptionGroup for Terminal

const NAME: &'static str = "terminal"

const DOC: &'static str = "PTY-backed terminal buffer."

impl OptionGroup for Window

const NAME: &'static str = "window"

const DOC: &'static str = "GPUI window options (borderless chrome, maximize on launch). GPUI peer only."