Enum SnippetActivationMode 

pub enum SnippetActivationMode {
    Global,
    SupportedLanguages,
    Off,
}

snippet.activation — which buffers get snippets.

A closed three-value set (hence a typed enum rather than a free-form string): Global activates on every real document buffer; SupportedLanguages activates only for major modes in the snippet.languages allowlist; Off never auto-activates.

Variants

Global

Snippets on every document buffer (the default). The completion source still self-filters by language, so Global means “each buffer sees its own language’s snippets”, not “all snippets everywhere”.

SupportedLanguages

Snippets only for languages listed in snippet.languages. Resolves to Majors([<lang>-mode …]), which matches only registered major modes.

Off

Snippets disabled — never auto-activate. Explicit :snippet-mode / <C-x><C-s> paths still work where wired.

Implementations

impl SnippetActivationMode

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

Canonical :set label.

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

Parse a :set snippet.activation=<value> label.

Trait Implementations

impl Clone for SnippetActivationMode

fn clone(&self) -> SnippetActivationMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SnippetActivationMode

impl Debug for SnippetActivationMode

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

Formats the value using the given formatter.

impl Default for SnippetActivationMode

fn default() -> SnippetActivationMode

Returns the “default value” for a type.

impl Eq for SnippetActivationMode

impl OptionType for SnippetActivationMode

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 SnippetActivationMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SnippetActivationMode