Struct textpos::TextPosition

pub struct TextPosition { /* private fields */ }

Points to a certain character.

A TextPosition also keeps track of the human-interpretable position (ie. line/column).

Implementations

impl TextPosition

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

Crate a new TextPosition from raw parts

pub fn idx(&self) -> usize

The absolute index pointing to the char. 0 is the first character.

pub fn line(&self) -> usize

The line this position is on. 1 is the first line.

This is always equals to the number of inc_line() calls made on this position.

pub fn col(&self) -> usize

The column this position is on. 1 is the first column.

This is always equals to the number of inc_col() calls made on this position after the last inc_line() call.

pub fn inc_col(&mut self)

Move the position forward by one non-newline character.

pub fn inc_line(&mut self)

Move the position forward by one newline character.

pub fn previous(&self) -> TextPosition

Return the previous position.

Note, that when this is used on a position that is on the first column, then this will yield a previous position at the zeroth column (which doesn’t exist, 1 is the first column). Conceptually this represents the last character of the previous line, ie. the newline character.

Also, this function may not be called on a zeroth-column position or on a character with index 0.

Due to these peculiarities, the returned position should not be reused for further computations, only for formatting purposes.

Trait Implementations

impl Clone for TextPosition

fn clone(&self) -> TextPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextPosition

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

Formats the value using the given formatter.

impl Default for TextPosition

fn default() -> Self

Returns the “default value” for a type.

impl Display for TextPosition

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

Formats the value using the given formatter.

impl Ord for TextPosition

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<TextPosition> for TextPosition

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

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

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 Eq for TextPosition

impl StructuralEq for TextPosition

impl StructuralPartialEq for TextPosition