Struct OptionDesc 

pub struct OptionDesc {
    pub name: &'static str,
    pub aliases: &'static [&'static str],
    pub kind: OptKind,
    pub scope: OptScope,
    pub get: fn(&Settings) -> OptionValue,
    pub set: fn(&mut Settings, OptionValue) -> Result<(), String>,
}

One :set-able option.

Fields

name: &'static str

Canonical name, as :set name? echoes it and as a config key.

aliases: &'static [&'static str]

Vim-style short forms (cul for cursorline).

kind: OptKind

scope: OptScope

get: fn(&Settings) -> OptionValue

Read the live value.

set: fn(&mut Settings, OptionValue) -> Result<(), String>

Write it, rejecting a value the option cannot hold.

Implementations

impl OptionDesc

pub fn matches(&self, name: &str) -> bool

True when name is this option’s canonical name or one of its aliases.

pub fn all_names(&self) -> impl Iterator<Item = &'static str>

Canonical name plus every alias, for completion candidate lists.