Enum ModelineZone 

pub enum ModelineZone {
    Auto,
    Ids(Vec<Arc<str>>),
}

A modeline zone’s configured layout: descriptor-driven (Auto) or an explicit ordered element-id list (Ids).

Variants

Auto

Use the producer-registered descriptor placement for this zone (the built-in default). The default variant: with no config a newly-registered mode element appears in its descriptor’s zone automatically (preserves extensibility, paramount #2).

Ids(Vec<Arc<str>>)

An explicit, ordered list of element ids. Unknown / unregistered ids are skipped + logged by the host layout resolver (lattice_host::modeline); an empty list is an explicitly-blank zone (distinct from Auto).

Implementations

impl ModelineZone

pub fn ids(&self) -> Option<&[Arc<str>]>

The configured ids, or None for Self::Auto.

pub fn is_auto(&self) -> bool

Whether this is the descriptor-driven default.

Trait Implementations

impl Clone for ModelineZone

fn clone(&self) -> ModelineZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelineZone

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

Formats the value using the given formatter.

impl Default for ModelineZone

fn default() -> ModelineZone

Returns the “default value” for a type.

impl Eq for ModelineZone

impl OptionType for ModelineZone

fn enumerate() -> Option<Vec<&'static str>>

The id space is open-ended (built-ins + any mode/plugin element), so there is no fixed completion set — auto is surfaced as the one keyword form.

fn accepts_list() -> bool

ML.5: this is the list-shaped option the loader joins TOML arrays into. See OptionType::accepts_list + loader::apply_array.

fn parse(s: &str) -> Result<Self, String>

Parse the right-hand side of :set name=value. Errors are surfaced verbatim through the cmdline echo, so the message should read well to the user (mention valid forms when the space is finite). The parser MUST round-trip with format: T::parse(&v.format()) == Ok(v) for every v.

fn format(&self) -> String

Render the current value back to a string (:set foo? echo, the customize buffer view, value comparison). Round-trips with Self::parse.

fn type_label() -> &'static str

Short type label for :describe-option ("boolean", "foldmethod", etc.). Used in help bodies and the customize buffer view.

fn enumerate_with_docs() -> Option<Vec<EnumeratedValue>>

Optional: enumerate valid string forms WITH per-value doc strings for the cmdline-completion marginalia column. Default impl wraps Self::enumerate with empty docs; types with rich help override.

fn name_forms(_canonical: &str) -> Vec<String>

Optional: alternative name forms this type accepts for the option name itself. Used by completion to surface the name alongside its negation (:set nu / :set nonu). Default: no extra forms. Booleans return [format!("no{canonical}")].

fn is_bool() -> bool

Whether this type’s option supports :set noFOO. bool returns true; everything else false. Drives the negate path in the cmdline parser.

fn try_negation_value() -> Result<Self, String>

Negation value (only meaningful for Self::is_bool true). Default: returns Err – the registry guards by checking is_bool() first, so callers that respect the contract won’t observe this. The bool impl returns Ok(false).

fn enumerate_is_exhaustive() -> bool

Whether Self::enumerate is the COMPLETE set of valid values (a closed enum) or a completion hint over an open space.

fn schema() -> ConfigSchema

The declared shape of this type’s values.

fn to_value(&self) -> ConfigValue

This value as a schema-shaped tree.

fn from_value(value: &ConfigValue) -> Result<Self, String>

Rebuild from a tree. Default: the inverse of Self::to_value, deferring to parse so a type’s validation rules apply on this path exactly as they do on :set.

impl PartialEq for ModelineZone

fn eq(&self, other: &ModelineZone) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ModelineZone