Struct Location 

pub struct Location { /* private fields */ }

Either references a location in the original source file, or is Location::MISSING.

A location has a total order based on the byte offset, with Location::MISSING coming after every valid location.

Implementations

impl Location

pub const MISSING: Location

Indicates that the location information is missing, and doesn’t correspond to a known location in the source file.

For the purposes of a comparison using Ord, a missing value comes after all present values.

pub fn from_byte<T: PrimUInt>(byte_offset: T) -> Location

Create a Location referencing a byte offset in the source file.

Panics

If the byte offset is too large, this will panic.

pub const fn is_missing(self) -> bool

Determine if the location is Self::MISSING.

pub const fn byte_offset(self) -> Result<u64, MissingLocationError>

Return the byte offset of this location, or a MissingLocationError if missing.

pub fn to_span(self) -> Span

A span which points only to this location.

Returns Span::MISSING if this location is missing.

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() -> Self

Returns the “default value” for a type.

impl Display for Location

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

Formats the value using the given formatter.

impl From<ByteLocation> for Location

fn from(location: ByteLocation) -> Self

Converts to this type from the input type.

impl From<Location> for ByteLocation

fn from(location: Location) -> Self

Converts to this type from the input type.

impl From<Location> for Span

fn from(value: Location) -> Self

Converts to this type from the input type.

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

impl Eq for Location