Struct Location 

pub struct Location {
    pub start_line: u32,
    pub start_column: u32,
    pub end_line: u32,
    pub end_column: u32,
    pub start: u32,
    pub end: u32,
    pub file_name: Arc<PathBuf>,
}

Common Location type This type is used to store the location of a token in the input text. The location is stored as line and column numbers, and as start and end positions in the input text.

We don’t use std::ops::Range for the span information because we need to implement Ord and PartialOrd for Location.

Fields

start_line: u32

Position information: line number, starting by 1 A value of 0 indicates an invalid position, for instance for EOF token.

start_column: u32

Position information: column number, starting by 1 A value of 0 indicates an invalid position, for instance for EOF token.

end_line: u32

Position information: line number, starting by 1 A value of 0 indicates an invalid position, for instance for EOF token.

end_column: u32

Position information: column number, starting by 1 A value of 0 indicates an invalid position, for instance for EOF token.

start: u32

The start of the span of the token in the input text We use 0 also when dealing with artificial tokens introduced by the parser during error recovery.

end: u32

The end of the span of the token in the input text The end is exclusive. It is the first character after the span. We use 0 also when dealing with artificial tokens introduced by the parser during error recovery.

file_name: Arc<PathBuf>

The name of the input file

Implementations

impl Location

pub fn len(&self) -> usize

Calculate the length of the location

pub fn is_empty(&self) -> bool

Returns true if the location is empty

pub fn range(&self) -> Range<usize>

Create a std::ops::Range from the location This is useful to extract the text of the token from the input text.

pub fn start(&self) -> usize

Returns the start of the location

pub fn end(&self) -> usize

Returns the end of the location

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl Default for Location

fn default() -> Location

Returns the “default value” for a type.

impl Display for Location

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

Formats the value using the given formatter.

impl From<&Location> for Range<usize>

fn from(location: &Location) -> Self

Converts to this type from the input type.

impl From<&Token<'_>> for Location

fn from(token: &Token<'_>) -> Self

Converts to this type from the input type.

impl Hash for Location

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 Location

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

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

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

impl StructuralPartialEq for Location