Struct FoldRegion

pub struct FoldRegion {
    pub id: FoldRegionId,
    pub start_line: usize,
    pub end_line: usize,
    pub collapsed: bool,
}

Collapsible range of zero-based logical lines.

The line at FoldRegion::start_line remains visible when the region is collapsed; lines through FoldRegion::end_line are hidden. Callers are responsible for constructing ranges whose end is not before their start.

Examples

use ailloli_ui_editor::FoldRegion;

let region = FoldRegion::new(3, 6).collapsed(true);
assert!(!region.hides_line(3));
assert!(region.hides_line(4));
assert!(region.hides_line(6));

Fields

id: FoldRegionId

Stable identifier derived from the start and end lines.

start_line: usize

Zero-based header line that remains visible while collapsed.

end_line: usize

Zero-based inclusive last line hidden while collapsed.

collapsed: bool

Whether the region currently hides its body lines.

Implementations

impl FoldRegion

Constructs and queries fold regions.

pub fn new(start_line: usize, end_line: usize) -> Self

Creates an expanded region spanning start_line..=end_line.

The inputs are stored without ordering validation. Consequently, a reversed range hides no lines and reports a hidden count of zero.

Examples

use ailloli_ui_editor::FoldRegion;

let region = FoldRegion::new(4, 7);
assert_eq!((region.start_line, region.end_line), (4, 7));
assert!(!region.collapsed);

pub fn collapsed(self, collapsed: bool) -> Self

Sets whether the region is collapsed and returns it.

Examples

use ailloli_ui_editor::FoldRegion;

assert!(FoldRegion::new(0, 2).collapsed(true).collapsed);

pub fn hides_line(self, line: usize) -> bool

Returns whether a zero-based line is hidden by this region.

The header line is never hidden and the end line is inclusive.

Examples

use ailloli_ui_editor::FoldRegion;

let region = FoldRegion::new(5, 6).collapsed(true);
assert_eq!((region.hides_line(5), region.hides_line(6)), (false, true));

pub fn hidden_line_count(self) -> usize

Returns the number of body lines in the range, whether expanded or not.

Reversed ranges return zero rather than underflowing.

Examples

use ailloli_ui_editor::FoldRegion;

assert_eq!(FoldRegion::new(2, 5).hidden_line_count(), 3);
assert_eq!(FoldRegion::new(5, 2).hidden_line_count(), 0);

Trait Implementations

impl Clone for FoldRegion

fn clone(&self) -> FoldRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FoldRegion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FoldRegion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FoldRegion

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

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 PartialEq for FoldRegion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FoldRegion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FoldRegion

impl Eq for FoldRegion

impl StructuralPartialEq for FoldRegion