Skip to main content

FoldMethod

Enum FoldMethod 

Source
pub enum FoldMethod {
    Manual,
    Indent,
    Markdown,
    Syntax,
    Lsp,
}
Expand description

: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§

Source§

impl FoldMethod

Source

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

Canonical string label.

Source

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

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

Source

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

Variants in declaration order.

Source

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

Parse from canonical label or any registered alias.

Trait Implementations§

Source§

impl Clone for FoldMethod

Source§

fn clone(&self) -> FoldMethod

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FoldMethod

Source§

impl Debug for FoldMethod

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FoldMethod

Source§

fn default() -> FoldMethod

Returns the “default value” for a type. Read more
Source§

impl Eq for FoldMethod

Source§

impl Hash for FoldMethod

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FoldMethod

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FoldMethod

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.