Struct TextSelection

pub struct TextSelection {
    pub anchor: usize,
    pub caret: usize,
}

Caret and optional selection anchor (UTF-8 byte indices).

This value does not know the associated text and therefore permits out-of-range and non-boundary indices. TextEditState::clamp_to_buffer repairs them by clamping backward to valid UTF-8 boundaries.

Examples

use ailloli_ui_text::TextSelection;
let selection = TextSelection { anchor: 8, caret: 3 };
assert_eq!(selection.normalized(), (3, 8));

Fields

anchor: usize

Fixed end of an extended selection, as a UTF-8 byte index.

caret: usize

Moving end and active caret, as a UTF-8 byte index.

Implementations

impl TextSelection

pub fn collapsed(caret: usize) -> Self

Creates a zero-width selection at caret without validating it.

Examples

use ailloli_ui_text::TextSelection;
let selection = TextSelection::collapsed(5);
assert_eq!(selection, TextSelection { anchor: 5, caret: 5 });
assert!(selection.is_collapsed());

pub fn normalized(self) -> (usize, usize)

Returns (min(anchor, caret), max(anchor, caret)).

The pair is numerically ordered but is not clamped to any buffer.

Examples

use ailloli_ui_text::TextSelection;
assert_eq!(TextSelection { anchor: 9, caret: 2 }.normalized(), (2, 9));

pub fn is_collapsed(self) -> bool

Returns true when anchor and caret have the same byte index.

Examples

use ailloli_ui_text::TextSelection;
assert!(TextSelection::collapsed(0).is_collapsed());
assert!(!TextSelection { anchor: 0, caret: 1 }.is_collapsed());

Trait Implementations

impl Clone for TextSelection

fn clone(&self) -> TextSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSelection

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

Formats the value using the given formatter.

impl PartialEq for TextSelection

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

impl Eq for TextSelection

impl StructuralPartialEq for TextSelection