Struct Location

pub struct Location { /* private fields */ }

Represents a source location. This location includes spanning lines and columns and the reference compilation unit.

Implementations

impl Location

pub fn with_offsets( compilation_unit: &Rc<CompilationUnit>, first_offset: usize, last_offset: usize, ) -> Self

Builds a location.

pub fn with_offset( compilation_unit: &Rc<CompilationUnit>, offset: usize, ) -> Self

Builds a location.

pub fn combine_with(&self, other: Location) -> Self

Build a location by combining two locations. self serves as the first location, while other serves as the last location.

pub fn combine_with_start_of(&self, other: Location) -> Self

Build a location by combining two locations. self serves as the first location, while the first column and first line of other serve as the last location.

pub fn compilation_unit(&self) -> Rc<CompilationUnit>

The compilation unit that this location belongs to.

pub fn first_line_number(&self) -> usize

First line number, counted from one.

pub fn last_line_number(&self) -> usize

Last line number, counted from one.

pub fn first_offset(&self) -> usize

pub fn last_offset(&self) -> usize

pub fn first_column(&self) -> usize

Zero based first column of the location in code points.

pub fn last_column(&self) -> usize

Zero based last column of the location in code points.

pub fn first_column_offset(&self) -> usize

Zero based first column offset of the location.

pub fn last_column_offset(&self) -> usize

Zero based last column offset of the location.

pub fn cursor_inside(&self, (line, column): (usize, usize)) -> bool

Takes (line, column).

Parameters

• line - One-based line number for the cursor
• column - Zero-based column number (in code points) for the cursor

pub fn character_count(&self) -> usize

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

Indicates whether a previous location and a next location have a line break in between.

pub fn text(&self) -> String

Returns the source text comprising the source location.

pub fn shift_until_eof(&self, count: usize) -> Location

Shifts a count of characters off this location until end-of-file.

pub fn shift_whitespace(&self, text: &str) -> Location

Shifts the count of first whitespace characters in a text off this location.

pub fn show_code(&self) -> String

Returns a string containing related code line. The returned string is in the following format:

LINENO |   someCode();
           ^

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for Location

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Location

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 Location

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 Location

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 Serialize for Location

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Location