Struct OptionSpec 

pub struct OptionSpec {
    pub name: Cow<'static, str>,
    pub short_form: Option<Cow<'static, str>>,
    pub description: Cow<'static, str>,
    pub default: OptionValue,
    pub constraint: OptionConstraint,
    pub scope: OptionScope,
    pub owner: Option<ModuleId>,
}

Complete specification for an editor option.

This is the MECHANISM type - it defines the structure of options. POLICY (which options exist and what they do) is in modules.

Example

use reovim_kernel::api::v1::*;

let spec = OptionSpec::new("tabwidth", "Tab width in spaces", OptionValue::int(4))
    .with_short("tw")
    .with_constraint(OptionConstraint::range(1, 32))
    .with_scope(OptionScope::Buffer);

Fields

name: Cow<'static, str>

Full option name (e.g., “number”, “tabwidth”).

short_form: Option<Cow<'static, str>>

Short alias (e.g., “nu” for “number”).

description: Cow<'static, str>

Human-readable description.

default: OptionValue

Default value (also defines the type).

constraint: OptionConstraint

Constraints for validation.

scope: OptionScope

Scope (global, buffer-local, window-local).

owner: Option<ModuleId>

Module that registered this option (for lifecycle cleanup).

Implementations

impl OptionSpec

pub fn new( name: impl Into<Cow<'static, str>>, description: impl Into<Cow<'static, str>>, default: OptionValue, ) -> Self

Create a new option specification.

pub fn with_short(self, short: impl Into<Cow<'static, str>>) -> Self

Add a short alias.

pub const fn with_constraint(self, constraint: OptionConstraint) -> Self

Add validation constraints.

pub const fn with_scope(self, scope: OptionScope) -> Self

Set the scope.

pub fn with_owner(self, owner: ModuleId) -> Self

Set the owning module.

pub const fn owner(&self) -> Option<&ModuleId>

Get the owning module, if set.

pub fn matches_name(&self, query: &str) -> bool

Check if this option matches a name (full name or alias).

pub fn validate(&self, value: &OptionValue) -> Result<(), OptionError>

Validate a value against this option’s type and constraints.

Errors

Returns error if value type doesn’t match or violates constraints.

Trait Implementations

impl Clone for OptionSpec

fn clone(&self) -> OptionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionSpec

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

Formats the value using the given formatter.