Struct Cursor 

pub struct Cursor {
    pub block: usize,
    pub part: Part,
    pub offset: usize,
}

A caret: which block, which part of it, and how far into that part.

Byte offsets, like the marks — and like them, always on a character boundary.

Fields

block: usize

part: Part

offset: usize

Implementations

impl Cursor

pub fn new(block: usize, part: Part, offset: usize) -> Self

pub fn len_in(self, doc: &Doc) -> Option<usize>

How much text this position’s part holds, or None when the block has no such part — an image and a rule have none at all.

pub fn clamp(self, doc: &Doc) -> Self

Pull the caret back onto a real position: a block that exists, a part that block has, an offset inside it, and a character boundary.

pub fn left(self, doc: &Doc) -> Self

One character left, stepping into the part or block before it.

pub fn right(self, doc: &Doc) -> Self

One character right, stepping into the part or block after it.

pub fn up(self, doc: &Doc) -> Self

The row above, keeping the offset where it fits.

Within a table that is the cell above in the same column; everywhere else it is the block above. A wrapped paragraph’s visual lines are not reachable from here — that needs the paint’s layout, and the editor resolves it there.

pub fn down(self, doc: &Doc) -> Self

The row below, keeping the offset where it fits.

pub fn home(self) -> Self

pub fn end(self, doc: &Doc) -> Self

pub fn word_left(self, doc: &Doc) -> Self

The start of the word at or before the caret — alt-left.

Whitespace first, then the run of word characters, which is the rule every platform’s word-left follows and the one ui::TextField uses.

pub fn word_right(self, doc: &Doc) -> Self

The end of the word at or after the caret — alt-right.

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

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

impl Ord for Cursor

fn cmp(&self, other: &Cursor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Cursor

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Cursor

fn partial_cmp(&self, other: &Cursor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Cursor