Enum SignColumn 

pub enum SignColumn {
    Yes,
    No,
}

signcolumn — whether to reserve the gutter sign columns.

Only yes / no are wired today. Vim’s auto (reserve only when a sign is present) is intentionally deferred: it re-introduces the layout shift the unconditional reserve exists to avoid.

Variants

Yes

Always reserve the severity + diff-sign columns, so the buffer layout never shifts when a sign appears or clears. The default.

No

Never reserve them — content abuts the line-number gutter. Help / synthetic buffers set this for clean, gutterless render.

Implementations

impl SignColumn

pub fn label(&self) -> &'static str

The on-disk / :set spelling: yes or no. The inverse of Self::parse_label.

pub fn doc(&self) -> &'static str

One-line description of this value for the :set value completion marginalia.

pub fn reserved(&self) -> bool

Whether the sign columns should be reserved for this value. The single predicate every renderer reads to gate the two sign-column cells.

pub fn all() -> [SignColumn; 2]

Every value, in completion order (the closed value set).

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

Parse a Self::label back into a value. Exact match — vim’s auto / number forms are rejected, not approximated.

Examples

use lattice_config::SignColumn;

assert!(SignColumn::default().reserved());
assert_eq!(SignColumn::parse_label("no"), Ok(SignColumn::No));
assert!(!SignColumn::No.reserved());
assert!(SignColumn::parse_label("auto").is_err());

Trait Implementations

impl Clone for SignColumn

fn clone(&self) -> SignColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SignColumn

impl Debug for SignColumn

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

Formats the value using the given formatter.

impl Default for SignColumn

fn default() -> SignColumn

Returns the “default value” for a type.

impl Eq for SignColumn

impl OptionType for SignColumn

fn enumerate_is_exhaustive() -> bool

TC.1: closed — parse accepts these forms and nothing else, so the schema is an enum and :customize can offer a picker.

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() -> Option<Vec<&'static str>>

Optional: enumerate valid string forms for :set foo=<Tab> completion. None means “free-form” (no enumerable space – integers, file paths, free strings). The values are &'static str to keep the completion source allocation-free in the common case.

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 accepts_list() -> bool

Whether this option’s value is list-shaped — i.e. a TOML array at config-load time should be joined into the delimited string Self::parse accepts, rather than rejected as “not applicable to a scalar option”. false for every scalar type (the default); true for list types like crate::ModelineZone. Drives loader::apply_array (ML.5). The :set cmdline path is unaffected — it always passes a string and never sees a TOML array.

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 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 SignColumn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SignColumn