Struct CaretSelection 

pub struct CaretSelection {
    pub anchor: CaretPosition,
    pub caret: CaretPosition,
}

A text selection with an anchor and a caret, each with its own affinity.

The anchor stays fixed while the caret moves. The caret can be on either side of the anchor, so use CaretSelection::byte_range to get the range in logical order.

Fields

anchor: CaretPosition

The fixed position of the selection, which may be its logical start or end.

caret: CaretPosition

The active position of the selection. When it equals anchor, the selection is empty.

Implementations

impl CaretSelection

pub fn is_empty(&self) -> bool

Returns whether the anchor and the caret have the same byte index.

Affinity is ignored, so a caret at a wrap point with two affinities is still empty.

pub fn endpoint_ordering(self) -> Ordering

Compares the caret’s byte index with the anchor’s. Less means the caret is before the anchor.

pub fn byte_range(self) -> Range<usize>

Returns the selected UTF-8 byte range, with the smaller index first.

pub fn min(self, max_idx: usize) -> Self

Limits both selection endpoints to max_idx while preserving their affinities.

pub fn with_caret(self, caret: CaretPosition) -> Self

Moves the active end while preserving the anchor.

Trait Implementations

impl Clone for CaretSelection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaretSelection

impl Debug for CaretSelection

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

Formats the value using the given formatter.

impl Default for CaretSelection

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CaretSelection

impl From<CaretPosition> for CaretSelection

fn from(caret: CaretPosition) -> Self

Converts to this type from the input type.

impl From<Range<usize>> for CaretSelection

fn from(range: Range<usize>) -> Self

Creates a selection whose caret is at range.start and whose anchor is at range.end.

impl From<usize> for CaretSelection

fn from(index: usize) -> Self

Converts to this type from the input type.

impl PartialEq for CaretSelection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaretSelection