Struct 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 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: i32, text: &Text, area: &impl Area, cfg: &PrintCfg, )

Internal horizontal movement function.

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

Internal vertical movement function.

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

Internal vertical movement function.

pub fn shift_by( &mut self, shift: (i32, i32, i32), text: &Text, area: &impl Area, cfg: &PrintCfg, )

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) -> u32

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

pub fn char(&self) -> u32

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

pub fn col(&self) -> u32

The column of the caret. Indexed at 0.

pub fn line(&self) -> u32

The line of the caret. Indexed at 0.

pub fn range(&self, inclusive: bool) -> Range<u32>

Returns the range between target and anchor.

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

Warning

This function will return the range that is supposed to be replaced, if self.is_inclusive(), this means that it will return one more byte at the end, i.e. start..=end.

pub fn start(&self) -> Point

The starting Point of this Cursor

pub fn point_range(&self, is_incl: bool, text: &Text) -> (Point, Point)

Returns the range between target and anchor.

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

Warning

Unlike Self::range(), this function ignores the “inclusiveness” of the range.

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

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

Formats the value using the given formatter.

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