Enum Selection

pub enum Selection {
    Simple {
        region: Range<Anchor>,
    },
    Semantic {
        region: Range<Point<isize>>,
    },
    Lines {
        region: Range<Point<isize>>,
        initial_line: isize,
    },
}

Describes a region of a 2-dimensional area

Used to track a text selection. There are three supported modes, each with its own constructor: simple, semantic, and lines. The simple mode precisely tracks which cells are selected without any expansion. semantic mode expands the initial selection to the nearest semantic escape char in either direction. lines will always select entire lines.

Calls to [update] operate different based on the selection kind. The simple mode does nothing special, simply tracks points and sides. semantic will continue to expand out to semantic boundaries as the selection point changes. Similarly, lines will always expand the new point to encompass entire lines.

Variants

Simple

Fields

region: Range<Anchor>

The region representing start and end of cursor movement

Semantic

Fields

region: Range<Point<isize>>

The region representing start and end of cursor movement

Lines

Fields

region: Range<Point<isize>>

The region representing start and end of cursor movement

initial_line: isize

The line under the initial point. This is always selected regardless of which way the cursor is moved.

Implementations

impl Selection

pub fn simple(location: Point<usize>, side: Side) -> Selection

pub fn rotate(&mut self, offset: isize)

pub fn semantic(point: Point<usize>) -> Selection

pub fn lines(point: Point<usize>) -> Selection

pub fn update(&mut self, location: Point<usize>, side: Side)

pub fn to_span<G>(&self, grid: &G, alt_screen: bool) -> Option<Span>

where G: Search + Dimensions,

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl PartialEq for Selection

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