Struct Position

pub struct Position {
    pub line: u32,
    pub column: u32,
    pub index: usize,
}

Represents a position in a text, consisting of line, column, and byte index.

Fields

line: u32

The current line number (starting from 1).

column: u32

The current column number (starting from 1).

index: usize

The current byte index in the text (starting from 0).

Implementations

impl Position

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

Creates a new Position with the given line, column, and index.

Arguments

• line - The line number (1-based).
• column - The column number (1-based).
• index - The byte index in the text (0-based).

Example

use roan_error::Position;
let pos = Position::new(1, 1, 0);
assert_eq!(pos.line(), 1);
assert_eq!(pos.column(), 1);
assert_eq!(pos.index(), 0);

pub fn increment_line(&mut self)

Increments the line number, resets the column to 1, and increments the index by 1.

pub fn increment_column(&mut self)

Increments the column number and the index by 1.

pub fn line(&self) -> u32

Returns the current line number.

Returns

The line number (1-based).

pub fn column(&self) -> u32

Returns the current column number.

Returns

The column number (1-based).

pub fn index(&self) -> usize

Returns the current byte index.

Returns

The byte index (0-based).

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Self

Returns a default Position, starting at line 1, column 1, and index 0.

Example

use roan_error::Position;
let default_pos = Position::default();
assert_eq!(default_pos, Position::new(1, 1, 0));

impl Display for Position

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

Formats the position as line:column (index: byte_index).

Example

use roan_error::Position;
let pos = Position::new(1, 1, 0);
assert_eq!(format!("{}", pos), "1:1 (index: 0)");

impl Hash for Position

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Position

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

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

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

impl Eq for Position

impl StructuralPartialEq for Position