Struct minparser::Position

pub struct Position<FILE = ()> { /* private fields */ }

A position.

Characters in a text file can be organizes in a virtual grid in order to easily find characters or parsing errors inside the file. Each file can be divided in multiple lines separated by line feed (U+000A) or carriage return + line feed (U+000D + U+000A).

To find a character then you need just the index of the line containing it (the first line has index 0) and the character index inside thai line (also called the column).

Type F is any type that can be used to identify a text file, for example a String, a Path or a custom type.

Implementations

impl<F> Position<F>

pub fn new_file(file: F, line: u32, column: u32) -> Self

Create a new Position at specified file, line and column indices

pub fn new_file_zero(file: F) -> Self

Create a new Position with line=0 and column=0

pub fn file(&self) -> &F

Get the file identifier

pub fn line(&self) -> u32

Get the line number

pub fn column(&self) -> u32

Get the column number

pub fn make_ref<'a>(&'a self) -> Position<&'a F>

Converts it to a reference

impl<F> Position<F>

where F: Default,

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

Like Position::new_file but with file argument set to F::default()

pub fn new_zero() -> Self

Like Position::new_file_zero but with file argument set to F::default()

Trait Implementations

impl<FILE: Clone> Clone for Position<FILE>

fn clone(&self) -> Position<FILE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FILE: Debug> Debug for Position<FILE>

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

Formats the value using the given formatter.

impl<FILE: PartialEq> PartialEq for Position<FILE>

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

impl<FILE: Eq> Eq for Position<FILE>

impl<FILE> StructuralPartialEq for Position<FILE>