Struct Cursor 

pub struct Cursor {
    pub offset: usize,
    pub logical_pos: Point,
    pub visual_pos: Point,
    pub column: CoordType,
    pub wrap_opp: bool,
}

Stores a position inside a ReadableDocument.

The cursor tracks both the absolute byte-offset, as well as the position in terminal-related coordinates.

Fields

offset: usize

Offset in bytes within the buffer.

logical_pos: Point

Position in the buffer in lines (.y) and grapheme clusters (.x).

Line wrapping has NO influence on this.

visual_pos: Point

Position in the buffer in laid out rows (.y) and columns (.x).

Line wrapping has an influence on this.

column: CoordType

Horizontal position in visual columns.

Line wrapping has NO influence on this and if word wrap is disabled, it’s identical to visual_pos.x. This is useful for calculating tab widths.

wrap_opp: bool

When measure_forward hits the word_wrap_column, the question is: Was there a wrap opportunity on this line? Because if there wasn’t, a hard-wrap is required; otherwise, the word that is being laid-out is moved to the next line. This boolean carries this state between calls.

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

impl Eq for Cursor

impl StructuralPartialEq for Cursor