Struct SourcePos 

pub struct SourcePos { /* private fields */ }

Position in source code.

The position is represented by its offset, line, and column. The offset is a zero-based byte index, the line and column are one-based character indices.

The Eq, PartialEq, Ord, and PartialOrd traits are implemented in terms of the offset. This reflects an assumption that the line and column are derived information.

Example

use sari::SourcePos;

let pos = SourcePos::new(69, 5, 7); // offset 69, line 5, column 7

assert_eq!(pos.offset(), 69);
assert_eq!(pos.line(), 5);
assert_eq!(pos.column(), 7);

Implementations

impl SourcePos

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

Creates a new SourcePos with specified offset, line, and column.

Example

use sari::SourcePos;

let pos = SourcePos::new(69, 5, 7); // offset 69, line 5, column 7

assert_eq!(pos.offset(), 69);
assert_eq!(pos.line(), 5);
assert_eq!(pos.column(), 7);

pub fn offset(&self) -> usize

Returns the offset.

pub fn line(&self) -> usize

Returns the line.

pub fn column(&self) -> usize

Returns the column.

Trait Implementations

impl Clone for SourcePos

fn clone(&self) -> SourcePos

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourcePos

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

Formats the value using the given formatter.

impl Display for SourcePos

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

Formats the value using the given formatter.

impl Ord for SourcePos

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 SourcePos

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

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 SourcePos

impl Eq for SourcePos