Struct ReadOnly 

pub struct ReadOnly;

Whether the buffer is read-only (mutating operators reject; :w still permits explicit writes if a path exists). customizable = false because this is mode-driven, not a user-typed config: major modes like help-mode, file-tree-mode, and the LSP log modes contribute ReadOnly = true via Mode::options() (per mode-architecture.md §6.5.3 read-only-mode pattern). Users who want to flip it on / off for a particular buffer use :enable read-only-mode, not :set read-only=true. That minor exists — it is declared in lattice_mode::modes::display and registered with the other foundation modes; the parenthetical here used to read “when that minor mode lands in M.7” long after it had, which is enough to send a reader off to build a second one.

A provider whose buffer is read-only conditionally — same kind, same major, editable or not depending on what it is showing — activates that minor on the buffer via ModeActivator::activate_minor_by_id and clears it with deactivate_minor_by_id, rather than reaching for this option directly.

Implementations

impl ReadOnly

pub fn build_spec() -> Option<bool>

Build the runtime spec for this declaration. Used by the registry’s self-registration boot path; not generally called by hand. Direct construction of Option<T> is the macro’s internal-only path – consumer code uses config.get_typed::<#name_ident>() to read and config.set_typed::<#name_ident>(...) to write.

Trait Implementations

impl HasGroup for ReadOnly

const GROUP_NAME: &'static str = <crate::Editor as ::lattice_config::OptionGroup>::NAME

Group display name ("editor", "lsp", …). The macro pulls this from the group = SomeGroup; directive at the declaration block’s head.

impl OptionDecl for ReadOnly

const NAME: &'static str = ReadOnly

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 = ReadOnly

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

const CUSTOMIZABLE: bool = false

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

type Value = bool

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

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.

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.