Struct Cursor 

pub struct Cursor {
    pub head: CursorPosition,
    pub anchor: CursorPosition,
    pub preferred_column: Option<usize>,
}

Available on crate feature editor only.

A cursor in the editor, with head and anchor for selection.

Fields

head: CursorPosition

The head (active end) of the cursor/selection

anchor: CursorPosition

The anchor (fixed end) of the cursor/selection

preferred_column: Option<usize>

Preferred column for vertical movement (remembers column when moving through short lines)

Implementations

impl Cursor

pub const fn new(position: CursorPosition) -> Self

Create a new cursor at a position (no selection).

pub const fn zero() -> Self

Create a cursor at the start of the document.

pub const fn with_selection( head: CursorPosition, anchor: CursorPosition, ) -> Self

Create a cursor with a selection range.

pub fn has_selection(&self) -> bool

Check if the cursor has an active selection.

pub fn selection_start(&self) -> CursorPosition

Get the selection start (minimum position).

pub fn selection_end(&self) -> CursorPosition

Get the selection end (maximum position).

pub fn collapse(&mut self)

Collapse selection by moving anchor to head.

pub fn move_to(&mut self, position: CursorPosition, extend_selection: bool)

Move the cursor to a new position, optionally extending selection.

pub fn set_preferred_column(&mut self, column: usize)

Set the preferred column for vertical movement.

pub fn clear_preferred_column(&mut self)

Clear the preferred column.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate 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() -> Cursor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cursor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for Cursor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Cursor

impl Eq for Cursor

impl StructuralPartialEq for Cursor