Struct Coords

pub struct Coords {
    pub absolute: usize,
    pub line: usize,
    pub column: usize,
}

A Coords represents a single location within the parser input

Fields

absolute: usize

The absolute character position

line: usize

The row position

column: usize

The column position

Implementations

impl Coords

Associated functions for the Coords struct

pub fn from_coords(value: &Coords) -> Self

Create a new coordinate based on a coordinate reference

pub fn from_line(line: usize) -> Self

Create a new coordinate starting on a specific line

pub fn is_before(&self, other: &Coords) -> bool

Check whether this coordinate is strictly before another coordinate

pub fn is_after(&self, other: &Coords) -> bool

Check whether this coordinate is strictly after another coordinate

pub fn copy_from(&mut self, other: &Coords)

Take all the values of the supplied Coords instance

pub fn increment(&mut self)

In place increment

pub fn decrement(&mut self)

In place decrement

pub fn increment_newline(&mut self)

In place increment with a line return

pub fn copy_increment(&self) -> Self

Increment the coordinate within the current line and return new struct

pub fn copy_increment_newline(&self) -> Self

Increment the coordinates and bump the line number (assumes that the new line will start in column zero) and return new struct

pub fn copy_decrement(&mut self) -> Self

Decrement the coordinate within the current line, but panic if we try and decrement column or absolute below zero, return a new struct

Trait Implementations

impl Clone for Coords

fn clone(&self) -> Coords

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Coords

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

Formats the value using the given formatter.

impl Default for Coords

fn default() -> Self

The default set of coordinates are positioned at the start of the first row

impl Display for Coords

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

Formats the value using the given formatter.

impl Ord for Coords

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 Coords

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

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 Copy for Coords

impl Eq for Coords

impl StructuralPartialEq for Coords