Struct Range 

pub struct Range {
    pub start: Cur,
    pub end: Cur,
    pub start_active: bool,
}

A Range is a closed interval [start, end] that includes both the starting cursor and the ending cursor.

This is equivalent to a stdlib range of the form from..=to rather than from..to as you might expect. This is also different from how GapBuffer slicing works (which uses traditional half-open ranges) so care needs to be taken when using a Range to select sub-regions of a Buffer.

A Range where start == end is considered a “null range” and may be collapsed to a single cursor via the collapse_null_range method on Dot.

Why do this?

The primary purpose of a Range is to represent the currently selected text within a given Buffer and we need to be able to manipulate both ends of that selection as isolated Cur instances within the text. As such, we really need both the start and end cursor to have the same semantics and behaviour and we also need to be able to pop them off, manipulate them and recombine them to produce new Ranges. While using a half-open interval would make using Ranges for slicing simpler, the trade off is that it makes a lot of the more complicated operations we need to perform (expanding selections, mapping mouse selections etc) significantly harder to reason about as you end up needing to map back and forth between the end of a Range and the Cur that represents the final character in that Range.

Fields

start: Cur

end: Cur

start_active: bool

Implementations

impl Range

pub const BOF: Self

Beginning of file

pub fn as_string_addr(&self, b: &Buffer) -> String

pub fn flip(&mut self)

pub fn active_cursor(&self) -> Cur

pub fn set_active_cursor(&mut self, c: Cur)

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl From<Range> for Dot

fn from(r: Range) -> Self

Converts to this type from the input type.

impl Ord for Range

fn cmp(&self, other: &Range) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Range

fn eq(&self, other: &Range) -> 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 PartialOrd for Range

fn partial_cmp(&self, other: &Range) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Range

impl Eq for Range

impl StructuralPartialEq for Range