Struct FoldingManager

Source

pub struct FoldingManager { /* private fields */ }

Expand description

Folding manager

Implementations§

Source §

impl FoldingManager

Source

pub fn new() -> Self

Create an empty folding manager.

Source

pub fn add_region(&mut self, region: FoldRegion)

Add a user-created fold region.

Source

pub fn remove_region(&mut self, start_line: usize, end_line: usize) -> bool

Remove a user-created fold region.

Source

pub fn get_region_for_line(&self, line: usize) -> Option<&FoldRegion>

Get fold region containing specified line (merged view).

Source

pub fn get_region_for_line_mut( &mut self, line: usize, ) -> Option<&mut FoldRegion>

Get mutable reference to a fold region containing specified line (prefers user folds).

Source

pub fn collapse_line(&mut self, line: usize) -> bool

Collapse specified line

Source

pub fn expand_line(&mut self, line: usize) -> bool

Expand specified line

Source

pub fn toggle_line(&mut self, line: usize) -> bool

Toggle fold state of specified line

Source

pub fn toggle_region_starting_at_line(&mut self, start_line: usize) -> bool

Toggle fold region starting at specified line (preferring “innermost” region).

rust-analyzer / LSP folding ranges often contain nested regions. To make TUI and other frontends behave more intuitively when “cursor is on a start line”, we choose:

Among all regions with start_line == line, the one with smallest end_line (innermost)

Source

pub fn logical_to_visual( &self, logical_line: usize, base_visual: usize, ) -> Option<usize>

Calculate mapping from logical line to visual line

Returns the visual line number for the specified logical line number, or None if folded

Source

pub fn visual_to_logical(&self, visual_line: usize, base_visual: usize) -> usize

Calculate mapping from visual line to logical line

Source

pub fn regions(&self) -> &[FoldRegion]

Get all fold regions

Source

pub fn derived_regions(&self) -> &[FoldRegion]

Get all derived fold regions.

Source

pub fn user_regions(&self) -> &[FoldRegion]

Get all user-created fold regions.

Source

pub fn clear(&mut self)

Clear all fold regions (derived + user).

Source

pub fn clear_derived_regions(&mut self)

Clear all derived fold regions, leaving user folds intact.

Source

pub fn replace_derived_regions(&mut self, regions: Vec<FoldRegion>)

Replace derived fold regions (will be sorted by start line and deduplicated).

Source

pub fn replace_regions(&mut self, regions: Vec<FoldRegion>)

Replace fold regions with new list (legacy API).

This replaces derived fold regions, leaving user folds intact.

Source

pub fn expand_all(&mut self)

Expand all folds

Source

pub fn collapse_all(&mut self)

Collapse all regions

Source

pub fn apply_line_delta(&mut self, edit_line: usize, line_delta: isize)

Update fold regions to account for an edit that changes the number of logical lines.

This is intended to keep user folds stable across newline insertions/deletions.

edit_line is the logical line where the edit occurred (pre-edit).
line_delta is the net change in line count (+n for inserted newlines, -n for deleted).

Source