Struct duat_core::position::Cursor

pub struct Cursor { /* private fields */ }

A cursor in the text file. This is an editing cursor, not a printing cursor.

Implementations

impl Cursor

pub fn new( point: Point, text: &Text, area: &impl Area, cfg: &PrintCfg, ) -> Cursor

Returns a new instance of Cursor.

pub fn move_to( &mut self, point: Point, text: &Text, area: &impl Area, cfg: &PrintCfg, )

Moves to specific, pre calculated Point.

pub fn move_hor( &mut self, by: isize, text: &Text, area: &impl Area, cfg: &PrintCfg, )

Internal horizontal movement function.

pub fn move_ver( &mut self, by: isize, text: &Text, area: &impl Area, cfg: &PrintCfg, )

Internal vertical movement function.

pub fn move_ver_wrapped( &mut self, _by: isize, _text: &Text, _area: &impl Area, _cfg: &PrintCfg, )

Internal vertical movement function.

pub fn set_anchor(&mut self)

Sets the position of the anchor to be the same as the current cursor position in the file.

The anchor and current act as a range of text on the file.

pub fn unset_anchor(&mut self) -> Option<Point>

Unsets the anchor.

This is done so the cursor no longer has a valid selection.

pub fn swap_ends(&mut self)

Switches the position of the anchor and caret.

pub fn caret(&self) -> Point

Returns the cursor’s position on the screen.

pub fn anchor(&self) -> Option<Point>

pub fn byte(&self) -> usize

The byte (relative to the beginning of the file) of the caret. Indexed at 0.

pub fn char(&self) -> usize

The char (relative to the beginning of the file) of the caret. Indexed at 0.

pub fn vcol(&self) -> usize

The column of the caret. Indexed at 0.

pub fn line(&self) -> usize

The line of the caret. Indexed at 0.

pub fn range(&self) -> Range<usize>

Returns the range between target and anchor.

If anchor isn’t set, returns an empty range on target.

pub fn point_range(&self) -> (Point, Point)

Returns the range between target and anchor.

If anchor isn’t set, returns an empty range on target.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Self

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() -> Cursor

Returns the “default value” for a type.

impl Display for Cursor

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

Formats the value using the given formatter.