Struct modalkit::editing::cursor::Cursor

pub struct Cursor {
    pub x: usize,
    pub y: usize,
    /* private fields */
}

Represents a movable point within a document.

Fields

x: usize

The column offset of this cursor, starting at 0.

y: usize

The line offset of this cursor, starting at 0.

Implementations

impl Cursor

pub fn new(line: usize, column: usize) -> Self

Create a new cursor.

pub fn get_y(&self) -> usize

Get the line that this cursor is on.

pub fn get_x(&self) -> usize

Get the column that this is on.

pub fn set_x(&mut self, x: usize)

Set the column for this cursor.

pub fn set_y(&mut self, y: usize)

Set the line for this cursor.

pub fn left(&mut self, off: usize)

Move this cursor to the left by offset columns.

pub fn right(&mut self, off: usize)

Move this cursor to the right by offset columns.

pub fn down(&mut self, off: usize)

Move this cursor down by offset lines.

pub fn up(&mut self, off: usize)

Move this cursor up by offset lines.

Trait Implementations

impl Adjustable for Cursor

fn zero(&mut self)

Zero out this cursor’s line and column.

fn adjust(&mut self, adjs: &[CursorAdjustment])

Apply a CursorAdjustment to any applicable cursors.

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 CursorMovements<Cursor> for EditRope

fn range_of_movement( &self, cursor: &Cursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<EditRange<Cursor>>

Given an action’s movement, calculate the affected range base on the cursor’s current position.

fn first_word( &self, cursor: &Cursor, _: &CursorMovementsContext<'_, Cursor> ) -> Cursor

Calculate the position of the first word on the line of the provided cursor.

fn movement( &self, cursor: &Cursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<Cursor>

Calculate the position of the cursor after performing a movement.

fn range( &self, cursor: &Cursor, range: &RangeType, inclusive: bool, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<EditRange<Cursor>>

Calculate a cursor range based on a given cursor position and a RangeType.

impl CursorSearch<Cursor> for EditRope

fn find_char( &self, cursor: &Cursor, inclusive: bool, dir: MoveDir1D, multiline: bool, needle: char, count: usize ) -> Option<Cursor>

Search for a specific character.

fn find_matches( &self, start: &Cursor, end: &Cursor, needle: &Regex ) -> Vec<EditRange<Cursor>>

Find matches for a regular expression within a range.

fn find_regex( &self, cursor: &Cursor, dir: MoveDir1D, needle: &Regex, count: usize ) -> Option<EditRange<Cursor>>

Search for a regular expression.

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 From<Cursor> for CursorChoice

fn from(cursor: Cursor) -> Self

Converts to this type from the input type.

impl From<Cursor> for CursorState

fn from(cursor: Cursor) -> Self

Converts to this type from the input type.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Cursor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Wrappable for Cursor

fn set_wrap(&mut self, wrap: bool)

Set whether or not displayed lines should be wrapped.

impl Eq for Cursor

impl StructuralPartialEq for Cursor