Struct yash_syntax::source::Location

pub struct Location {
    pub code: Rc<Code>,
    pub index: usize,
}

Position of a character in source code.

Fields

code: Rc<Code>

Code that contains the character.

index: usize

Character position in the code, counted from 0.

Characters are counted in the number of Unicode scalar values, not bytes. That means the index should be between 0 and code.value.borrow().chars().count().

Implementations

impl Location

pub fn dummy<S: Into<String>>(value: S) -> Location

Creates a dummy location.

The returned location has unknown source and the given source code value. The start_line_number and index are 1.

This function is mainly for use in testing.

pub fn advance(&mut self, count: usize)

Increases the index by count.

This function panics if the result overflows.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy 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 PartialEq<Location> for Location

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Location

impl StructuralEq for Location

impl StructuralPartialEq for Location