Struct Cursor

pub struct Cursor {
    pub start: Pos,
    pub end: Option<Pos>,
}

A cursor is a selection of text. It has a start and end position of the selection.

Fields

start: Pos

The start position of the selection. The start position is the origin of the selection, not necessarily the first position.

end: Option<Pos>

The end position of the selection. If the end position is None, the cursor is a caret.

Implementations

impl Cursor

pub fn from_start(pos: Pos) -> Self

Create a new cursor with the given start position.

pub fn new(start: Pos, end: Pos) -> Self

Create a new cursor with the given start and end position.

pub fn move_cursor(&mut self, f: impl FnOnce(&mut Pos), shift: bool)

Move the cursor position. If shift is true, the end position will be moved instead of the start position.

pub fn delete_selection<T: Text + ?Sized>( &mut self, text: &mut impl TextEditable<T>, )

Delete the currently selected text and update the cursor position.

pub fn handle_input<T: Text + ?Sized>( &mut self, code: &Code, key: &Key, modifiers: &Modifiers, text: &mut impl TextEditable<T>, max_text_length: usize, )

Handle moving the cursor with the given key.

pub fn with_end(&mut self, f: impl FnOnce(&mut Pos))

Modify the end selection position

pub fn first(&self) -> &Pos

Returns first position of the selection (this could be the start or the end depending on the position)

pub fn last(&self) -> &Pos

Returns last position of the selection (this could be the start or the end depending on the position)

pub fn selection_len(&self, text: &(impl Text + ?Sized)) -> usize

Returns the length of the selection

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Cursor

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

impl StructuralPartialEq for Cursor