Enum FoldMethod 

pub enum FoldMethod {
    Manual,
    Indent,
    Markdown,
    Syntax,
    Lsp,
}

One open completion popup (DESIGN.md §5.11.3 vertico-style rendering). Built by Action::CommandLineCompleteOrAdvance when the user presses Tab; consumed by accept / dismiss / scroll actions. :set foldmethod=... (DESIGN.md §15:18, C.2; docs/user/folding.md). Decides which provider feeds the per-buffer fold list.

Each variant’s marginalia doc (right of =>) is what appears in :set foldmethod=<Tab>. Variant-level /// docs are for API/rustdoc consumers. Slice 3c.unify.option-docs-builtin migrated this enum to labeled_enum! — adding a new fold method is now one line; the label / parse_label / doc / all accessors are derived automatically.

D.3.f.0 added #[derive(Hash)] so the FoldRegistry can key its primary-provider map on FoldMethod.

Variants

Manual

Only user zf ranges, no auto-recompute.

Indent

Universal indent walker.

Markdown

ATX heading nesting (*.md).

Syntax

Tree-sitter scope queries; cascades to Markdown for .md buffers and Indent otherwise when the tree- sitter provider has nothing to offer.

Lsp

Feeds from textDocument/foldingRange. Async: the per-tick pump fires the request when the buffer’s document version changes; the response lands in a per-buffer cache and triggers a recompute. Cascades to Syntax when no attached server advertises the capability.

Slice: 4.4.f.

Implementations

impl FoldMethod

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

Canonical string label.

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

Short marginalia doc shown in cmdline-completion’s right-aligned column.

pub fn all() -> &'static [FoldMethod]

Variants in declaration order.

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

Parse from canonical label or any registered alias.

Trait Implementations

impl Clone for FoldMethod

fn clone(&self) -> FoldMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FoldMethod

impl Debug for FoldMethod

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

Formats the value using the given formatter.

impl Default for FoldMethod

fn default() -> FoldMethod

Returns the “default value” for a type.

impl Eq for FoldMethod

impl Hash for FoldMethod

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl OptionType for FoldMethod

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<FoldMethod, 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 FoldMethod

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FoldMethod