Struct Pos

pub struct Pos {
    pub col: usize,
    pub row: usize,
}

A cursor position

Fields

col: usize

The virtual column of the cursor. This can be more than the line length. To get the realized column, use Pos::col().

row: usize

The row of the cursor.

Implementations

impl Pos

pub fn new(col: usize, row: usize) -> Self

Creates a new cursor position.

pub fn up(&mut self, text: &(impl Text + ?Sized))

Moves the position up by one line.

pub fn down(&mut self, text: &(impl Text + ?Sized))

Moves the position down by one line.

pub fn right(&mut self, text: &(impl Text + ?Sized))

Moves the position right by one character.

pub fn left(&mut self, text: &(impl Text + ?Sized))

Moves the position left by one character.

pub fn move_row(&mut self, change: i32, text: &(impl Text + ?Sized))

Move the position’s row by the given amount. (positive is down, negative is up)

pub fn move_col(&mut self, change: i32, text: &(impl Text + ?Sized))

Move the position’s column by the given amount. (positive is right, negative is left)

pub fn col(&self, text: &(impl Text + ?Sized)) -> usize

Get the realized column of the position. This is the column, but capped at the line length.

pub fn row(&self) -> usize

Get the row of the position.

pub fn idx(&self, text: &(impl Text + ?Sized)) -> usize

Get the character index of the position.

pub fn realize_col(&mut self, text: &(impl Text + ?Sized))

If the column is more than the line length, cap it to the line length.

Trait Implementations

impl Clone for Pos

fn clone(&self) -> Pos

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pos

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

Formats the value using the given formatter.

impl Ord for Pos

fn cmp(&self, other: &Self) -> 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.

impl PartialEq for Pos

fn eq(&self, other: &Pos) -> 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 PartialOrd for Pos

fn partial_cmp(&self, other: &Self) -> 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 Eq for Pos

impl StructuralPartialEq for Pos