Skip to main content

Fold

Struct Fold 

Source
pub struct Fold {
    pub start_row: usize,
    pub end_row: usize,
    pub closed: bool,
    pub auto_generated: bool,
}
Expand description

A contiguous range of rows that the host can collapse to a single fold-marker line.

Folds are row-range spans: [start_row, end_row] inclusive. The buffer never elides content — [crate::Buffer::lines] always returns the full logical text regardless of fold state. It is the host’s render path that skips hidden rows and replaces them with a stub.

See the folds module documentation for the full invariant description.

Fields§

§start_row: usize

First row of the folded range (visible when closed).

§end_row: usize

Last row of the folded range, inclusive.

§closed: bool

true = collapsed (rows after start_row are hidden).

§auto_generated: bool

true when this fold was created by the auto-fold engine (tree-sitter foldmethod=expr). Manual folds created via zf / crate::Buffer::add_fold set this to false.

Used by crate::Buffer::set_auto_folds to distinguish auto folds (which it manages) from manual folds (which it leaves untouched).

Implementations§

Source§

impl Fold

Source

pub fn contains(&self, row: usize) -> bool

Source

pub fn hides(&self, row: usize) -> bool

True when row is hidden by a closed fold (i.e. inside the fold but not on its start_row marker line).

Source

pub fn line_count(&self) -> usize

Number of rows the fold spans.

Trait Implementations§

Source§

impl Clone for Fold

Source§

fn clone(&self) -> Fold

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 Fold

Source§

impl Debug for Fold

Source§

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

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

impl Eq for Fold

Source§

impl PartialEq for Fold

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Fold

Auto Trait Implementations§

§

impl Freeze for Fold

§

impl RefUnwindSafe for Fold

§

impl Send for Fold

§

impl Sync for Fold

§

impl Unpin for Fold

§

impl UnsafeUnpin for Fold

§

impl UnwindSafe for Fold

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