Enum Selection 

pub enum Selection {
    Text {
        anchor: usize,
        head: usize,
    },
    Node {
        pos: usize,
    },
    Cell {
        anchor: usize,
        head: usize,
    },
    All,
}

What is currently selected.

Variants

Text

A (possibly empty) text range. anchor is the fixed side, head the moving side; they may be in either order.

Fields

anchor: usize

Fixed end of the selection.

head: usize

Moving end (where the caret is).

Node

A single node selected as a unit, starting at pos.

Fields

pos: usize

Position directly before the selected node.

Cell

A rectangular range of table cells. anchor and head are the positions directly before the anchor and head cell nodes; the covered rectangle is whatever table-aware code derives from them. core treats this generically (for from/to/map); the table extension interprets the rectangle.

Fields

anchor: usize

Position before the anchor (fixed) cell.

head: usize

Position before the head (moving) cell.

All

The whole document.

Implementations

impl Selection

pub fn caret(pos: usize) -> Selection

A collapsed text caret at pos.

pub fn from(&self) -> usize

Lowest selected position.

pub fn to(&self, doc: &Node) -> usize

Highest selected position (relative to doc for All/Node/Cell).

pub fn is_empty(&self) -> bool

Whether the selection is an empty caret.

pub fn map(&self, doc: &Node, mapping: &Mapping) -> Selection

Map this selection forward through mapping, clamping into doc. A node or cell selection whose node was touched degrades to a caret.

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Selection

impl Debug for Selection

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

Formats the value using the given formatter.

impl Eq for Selection

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