Trait OptionDecl 

pub trait OptionDecl: 'static {
    type Value: OptionType;

    const NAME: &'static str;
    const DOC: &'static str;
    const CUSTOMIZABLE: bool = true;

    // Required method
    fn default_value() -> Self::Value;

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

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

Constants on the trait carry the metadata :set / TOML / :describe-option need; the type itself carries the identity (TypeId lookups for hot-path reads). The associated Value type’s OptionType impl carries the parse / format / enumerate machinery already in this crate.

'static bound: option types are zero-sized markers and have no runtime data; the 'static lets us key registry storage on TypeId.

Required Associated Constants

const NAME: &'static str

Public display name. Boundary-facing only – :set <NAME>=…, TOML keys, completion candidates, :describe-option. Internal access is type-driven. The macro derives this from the option’s identifier (with namespace prefix when declared via mode_options!); manually-typed NAMEs are not supported for built-in options.

const DOC: &'static str

Doc string. Shown in :describe-option, the :customize form’s per-row help, and :apropos results.

Provided Associated Constants

const CUSTOMIZABLE: bool = true

Customize-visibility flag. true (the default) ⇒ option appears in :set autocomplete + the :customize group view. false ⇒ plugin / engine-internal state, hidden from user surfaces. Equivalent of emacs’s defvar vs defcustom. (See mode-architecture.md §6.5.3.)

Required Associated Types

type Value: OptionType

The runtime value type. bool, i64, String, plus any domain enum that impls OptionType.

Required Methods

fn default_value() -> Self::Value

Default value. Returned by a function (rather than a const) so non-const-constructible types like String can be defaults.

Provided Methods

fn type_id() -> TypeId

where Self: Sized,

TypeId of the declaration type itself. Hot-path key for the registry’s type-driven storage. Default impl works for every concrete impl.

Dyn Compatibility

This trait is not dyn compatible.

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

Implementors

impl OptionDecl for AiLog

const NAME: &'static str = AiLog

const DOC: &'static str = AiLog

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for AiLogLevel

const NAME: &'static str = AiLogLevel

const DOC: &'static str = AiLogLevel

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for AutoWrapOption

const NAME: &'static str = AutoWrapOption

const DOC: &'static str = AutoWrapOption

const CUSTOMIZABLE: bool = true

type Value = AutoWrap

impl OptionDecl for Autoread

const NAME: &'static str = Autoread

const DOC: &'static str = Autoread

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for ClipboardEnabled

const NAME: &'static str = ClipboardEnabled

const DOC: &'static str = ClipboardEnabled

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for CommandLineExpandHeight

const NAME: &'static str = CommandLineExpandHeight

const DOC: &'static str = CommandLineExpandHeight

const CUSTOMIZABLE: bool = true

type Value = ExpandHeight

impl OptionDecl for CompletionAutoInsertSingle

const NAME: &'static str = CompletionAutoInsertSingle

const DOC: &'static str = CompletionAutoInsertSingle

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for CompletionExtraCommitChars

const NAME: &'static str = CompletionExtraCommitChars

const DOC: &'static str = CompletionExtraCommitChars

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for CompletionGhostText

const NAME: &'static str = CompletionGhostText

const DOC: &'static str = CompletionGhostText

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for CompletionSourceBufferWordsPriority

const NAME: &'static str = CompletionSourceBufferWordsPriority

const DOC: &'static str = CompletionSourceBufferWordsPriority

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for CompletionSourceLspPriority

const NAME: &'static str = CompletionSourceLspPriority

const DOC: &'static str = CompletionSourceLspPriority

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for CompletionSourcePathPriority

const NAME: &'static str = CompletionSourcePathPriority

const DOC: &'static str = CompletionSourcePathPriority

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for CompletionSourceSnippetPriority

const NAME: &'static str = CompletionSourceSnippetPriority

const DOC: &'static str = CompletionSourceSnippetPriority

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for CompletionSourceTreeSitterPriority

const NAME: &'static str = CompletionSourceTreeSitterPriority

const DOC: &'static str = CompletionSourceTreeSitterPriority

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for CursorLine

const NAME: &'static str = CursorLine

const DOC: &'static str = CursorLine

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for DiagnosticsInlineOption

const NAME: &'static str = DiagnosticsInlineOption

const DOC: &'static str = DiagnosticsInlineOption

const CUSTOMIZABLE: bool = true

type Value = DiagnosticsInline

impl OptionDecl for DiagnosticsMinSeverityOption

const NAME: &'static str = DiagnosticsMinSeverityOption

const DOC: &'static str = DiagnosticsMinSeverityOption

const CUSTOMIZABLE: bool = true

type Value = DiagnosticsSeverity

impl OptionDecl for ElectricIndent

const NAME: &'static str = ElectricIndent

const DOC: &'static str = ElectricIndent

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for EmacsKeys

const NAME: &'static str = EmacsKeys

const DOC: &'static str = EmacsKeys

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for EmacsKeysPrefix

const NAME: &'static str = EmacsKeysPrefix

const DOC: &'static str = EmacsKeysPrefix

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for ExpandTab

const NAME: &'static str = ExpandTab

const DOC: &'static str = ExpandTab

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for FoldEnable

const NAME: &'static str = FoldEnable

const DOC: &'static str = FoldEnable

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for FoldLevel

const NAME: &'static str = FoldLevel

const DOC: &'static str = FoldLevel

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for FoldMethodOption

const NAME: &'static str = FoldMethodOption

const DOC: &'static str = FoldMethodOption

const CUSTOMIZABLE: bool = true

type Value = FoldMethod

impl OptionDecl for FormatIndentChain

const NAME: &'static str = FormatIndentChain

const DOC: &'static str = FormatIndentChain

const CUSTOMIZABLE: bool = true

type Value = ProviderChain

impl OptionDecl for FormatOnSave

const NAME: &'static str = FormatOnSave

const DOC: &'static str = FormatOnSave

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for FormatPrg

const NAME: &'static str = FormatPrg

const DOC: &'static str = FormatPrg

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for FormatReflowChain

const NAME: &'static str = FormatReflowChain

const DOC: &'static str = FormatReflowChain

const CUSTOMIZABLE: bool = true

type Value = ProviderChain

impl OptionDecl for FormatReformatChain

const NAME: &'static str = FormatReformatChain

const DOC: &'static str = FormatReformatChain

const CUSTOMIZABLE: bool = true

type Value = ProviderChain

impl OptionDecl for HelpAproposDisplay

const NAME: &'static str = HelpAproposDisplay

const DOC: &'static str = HelpAproposDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for HelpDescribeDisplay

const NAME: &'static str = HelpDescribeDisplay

const DOC: &'static str = HelpDescribeDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for HelpListDisplay

const NAME: &'static str = HelpListDisplay

const DOC: &'static str = HelpListDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for HelpTopicDisplay

const NAME: &'static str = HelpTopicDisplay

const DOC: &'static str = HelpTopicDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for HoverDisplay

const NAME: &'static str = HoverDisplay

const DOC: &'static str = HoverDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for IgnoreCase

const NAME: &'static str = IgnoreCase

const DOC: &'static str = IgnoreCase

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for IndentGuides

const NAME: &'static str = IndentGuides

const DOC: &'static str = IndentGuides

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for IndentGuidesActive

const NAME: &'static str = IndentGuidesActive

const DOC: &'static str = IndentGuidesActive

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for IndentGuidesChar

const NAME: &'static str = IndentGuidesChar

const DOC: &'static str = IndentGuidesChar

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for IndentMethodOption

const NAME: &'static str = IndentMethodOption

const DOC: &'static str = IndentMethodOption

const CUSTOMIZABLE: bool = true

type Value = IndentMethod

impl OptionDecl for KeymapLeader

const NAME: &'static str = KeymapLeader

const DOC: &'static str = KeymapLeader

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for LspDiagnosticsToErrorList

const NAME: &'static str = LspDiagnosticsToErrorList

const DOC: &'static str = LspDiagnosticsToErrorList

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for LspLogCapacity

const NAME: &'static str = LspLogCapacity

const DOC: &'static str = LspLogCapacity

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for LspLogDisplay

const NAME: &'static str = LspLogDisplay

const DOC: &'static str = LspLogDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for LspLogLevel

const NAME: &'static str = LspLogLevel

const DOC: &'static str = LspLogLevel

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for LspReferencesToErrorList

const NAME: &'static str = LspReferencesToErrorList

const DOC: &'static str = LspReferencesToErrorList

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for LspStatusDisplay

const NAME: &'static str = LspStatusDisplay

const DOC: &'static str = LspStatusDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for MessagesDisplay

const NAME: &'static str = MessagesDisplay

const DOC: &'static str = MessagesDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for MessagesFilter

const NAME: &'static str = MessagesFilter

const DOC: &'static str = MessagesFilter

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for ModelineCenter

const NAME: &'static str = ModelineCenter

const DOC: &'static str = ModelineCenter

const CUSTOMIZABLE: bool = true

type Value = ModelineZone

impl OptionDecl for ModelineLeft

const NAME: &'static str = ModelineLeft

const DOC: &'static str = ModelineLeft

const CUSTOMIZABLE: bool = true

type Value = ModelineZone

impl OptionDecl for ModelinePadding

const NAME: &'static str = ModelinePadding

const DOC: &'static str = ModelinePadding

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for ModelineRight

const NAME: &'static str = ModelineRight

const DOC: &'static str = ModelineRight

const CUSTOMIZABLE: bool = true

type Value = ModelineZone

impl OptionDecl for ModelineSeparator

const NAME: &'static str = ModelineSeparator

const DOC: &'static str = ModelineSeparator

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for MouseEnabled

const NAME: &'static str = MouseEnabled

const DOC: &'static str = MouseEnabled

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for NoFile

const NAME: &'static str = NoFile

const DOC: &'static str = NoFile

const CUSTOMIZABLE: bool = false

type Value = bool

impl OptionDecl for Number

const NAME: &'static str = Number

const DOC: &'static str = Number

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PaneBufferHistorySize

const NAME: &'static str = PaneBufferHistorySize

const DOC: &'static str = PaneBufferHistorySize

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for PaneZoomIndicator

const NAME: &'static str = PaneZoomIndicator

const DOC: &'static str = PaneZoomIndicator

const CUSTOMIZABLE: bool = true

type Value = ZoomIndicator

impl OptionDecl for PathRelative

const NAME: &'static str = PathRelative

const DOC: &'static str = PathRelative

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PickerDisplay

const NAME: &'static str = PickerDisplay

const DOC: &'static str = PickerDisplay

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for PickerGrepBackend

const NAME: &'static str = PickerGrepBackend

const DOC: &'static str = PickerGrepBackend

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for PickerGrepMaxHits

const NAME: &'static str = PickerGrepMaxHits

const DOC: &'static str = PickerGrepMaxHits

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for PickerMruCapPerNamespace

const NAME: &'static str = PickerMruCapPerNamespace

const DOC: &'static str = PickerMruCapPerNamespace

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for PickerMruEnabled

const NAME: &'static str = PickerMruEnabled

const DOC: &'static str = PickerMruEnabled

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PickerMruPersist

const NAME: &'static str = PickerMruPersist

const DOC: &'static str = PickerMruPersist

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PickerMruRecencyHalfLifeDays

const NAME: &'static str = PickerMruRecencyHalfLifeDays

const DOC: &'static str = PickerMruRecencyHalfLifeDays

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for PickerOrderless

const NAME: &'static str = PickerOrderless

const DOC: &'static str = PickerOrderless

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PickerResultDisplay

const NAME: &'static str = PickerResultDisplay

const DOC: &'static str = PickerResultDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for PickerSendOpensProblems

const NAME: &'static str = PickerSendOpensProblems

const DOC: &'static str = PickerSendOpensProblems

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for PluginTraceLevelOption

const NAME: &'static str = PluginTraceLevelOption

const DOC: &'static str = PluginTraceLevelOption

const CUSTOMIZABLE: bool = true

type Value = PluginTraceLevel

impl OptionDecl for ProjectRootMarkers

const NAME: &'static str = ProjectRootMarkers

const DOC: &'static str = ProjectRootMarkers

const CUSTOMIZABLE: bool = true

type Value = RootMarkers

impl OptionDecl for ReadOnly

const NAME: &'static str = ReadOnly

const DOC: &'static str = ReadOnly

const CUSTOMIZABLE: bool = false

type Value = bool

impl OptionDecl for RelativeNumber

const NAME: &'static str = RelativeNumber

const DOC: &'static str = RelativeNumber

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for Scroll

const NAME: &'static str = Scroll

const DOC: &'static str = Scroll

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for Scrollbind

const NAME: &'static str = Scrollbind

const DOC: &'static str = Scrollbind

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for Scrolloff

const NAME: &'static str = Scrolloff

const DOC: &'static str = Scrolloff

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for Shiftwidth

const NAME: &'static str = Shiftwidth

const DOC: &'static str = Shiftwidth

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for Sidescroll

const NAME: &'static str = Sidescroll

const DOC: &'static str = Sidescroll

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for Sidescrolloff

const NAME: &'static str = Sidescrolloff

const DOC: &'static str = Sidescrolloff

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for SignColumnOption

const NAME: &'static str = SignColumnOption

const DOC: &'static str = SignColumnOption

const CUSTOMIZABLE: bool = true

type Value = SignColumn

impl OptionDecl for SignatureDisplay

const NAME: &'static str = SignatureDisplay

const DOC: &'static str = SignatureDisplay

const CUSTOMIZABLE: bool = true

type Value = BufferDisplayPreference

impl OptionDecl for StartMaximized

const NAME: &'static str = StartMaximized

const DOC: &'static str = StartMaximized

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for StartOfLine

const NAME: &'static str = StartOfLine

const DOC: &'static str = StartOfLine

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for TablineShowOption

const NAME: &'static str = TablineShowOption

const DOC: &'static str = TablineShowOption

const CUSTOMIZABLE: bool = true

type Value = TablineShow

impl OptionDecl for Tabstop

const NAME: &'static str = Tabstop

const DOC: &'static str = Tabstop

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for TerminalEscExits

const NAME: &'static str = TerminalEscExits

const DOC: &'static str = TerminalEscExits

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for TerminalScrollbackLines

const NAME: &'static str = TerminalScrollbackLines

const DOC: &'static str = TerminalScrollbackLines

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for TextWidth

const NAME: &'static str = TextWidth

const DOC: &'static str = TextWidth

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for TransientMaxRows

const NAME: &'static str = TransientMaxRows

const DOC: &'static str = TransientMaxRows

const CUSTOMIZABLE: bool = true

type Value = i64

impl OptionDecl for Whitespace

const NAME: &'static str = Whitespace

const DOC: &'static str = Whitespace

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for WhitespaceEol

const NAME: &'static str = WhitespaceEol

const DOC: &'static str = WhitespaceEol

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for WhitespaceLeading

const NAME: &'static str = WhitespaceLeading

const DOC: &'static str = WhitespaceLeading

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for WhitespaceSpace

const NAME: &'static str = WhitespaceSpace

const DOC: &'static str = WhitespaceSpace

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for WhitespaceTab

const NAME: &'static str = WhitespaceTab

const DOC: &'static str = WhitespaceTab

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for WhitespaceTrailing

const NAME: &'static str = WhitespaceTrailing

const DOC: &'static str = WhitespaceTrailing

const CUSTOMIZABLE: bool = true

type Value = String

impl OptionDecl for WindowDecorationsOption

const NAME: &'static str = WindowDecorationsOption

const DOC: &'static str = WindowDecorationsOption

const CUSTOMIZABLE: bool = true

type Value = Decorations

impl OptionDecl for Wrap

const NAME: &'static str = Wrap

const DOC: &'static str = Wrap

const CUSTOMIZABLE: bool = true

type Value = bool

impl OptionDecl for YankRingSize

const NAME: &'static str = YankRingSize

const DOC: &'static str = YankRingSize

const CUSTOMIZABLE: bool = true

type Value = i64