Struct Position 

pub struct Position {
    pub byte_offset: u64,
    pub line: u64,
    pub column: u64,
}

A point in a source file.

line and column are 1-based, as an editor reports them. byte_offset is 0-based, as a slice index requires.

Fields

byte_offset: u64

Offset from the start of the input, in bytes.

Sixty-four bits, because a reader that streams a window at a time is not bounded by what fits in memory and an offset past four gibibytes is ordinary rather than exceptional.

line: u64

1-based line number.

column: u64

1-based column number, counted in bytes.

Implementations

impl Position

pub const START: Self

The start of a file.

pub const fn new(byte_offset: u64, line: u64, column: u64) -> Self

Creates a position.

Examples

use molframe_core::Position;

let at = Position::new(42, 3, 7);
assert_eq!(at.line, 3);

pub const fn advance(self, byte: u8) -> Option<Self>

Advances past one byte, tracking the line and column.

A newline moves to column 1 of the next line; everything else advances the column. Carriage returns advance the column like any other byte, so a CRLF file reports the column of the visible character.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Position

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 the “default value” for a type.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

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: &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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Position

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Position

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 StructuralPartialEq for Position