Struct Location

pub struct Location {
    pub line: NonZero<u32>,
    pub col: u32,
}

Location of the error. Useful for error reporting, and used by crate::FullParsingError

Fields

line: NonZero<u32>

Source code line of the location.

col: u32

Source code column of the location.

Implementations

impl Location

pub const fn offset(self, rhs: Self) -> Self

Returns the Location that’s calculated with self as the base & rhs as the offset from the base.

Panics

Panics if the line or column overflow a u32

pub fn with_path<'path>(self, path: impl PathLike<'path>) -> FullLocation<'path>

Turn a Location into a FullLocation by providing the file path.

pub fn find(ptr: *const u8, src: &str) -> Option<Self>

Locates address ptr in src and returns its source code location, or None if ptr is outside of the memory range of src.

pub fn find_saturating(ptr: *const u8, src: &str) -> Self

Same as find, except for the None case:

• If ptr is before src, the returned location points to the beginning of src.
• If ptr is after src, the returned location points to the end of src.

This function is used by crate::ParsingError::with_src_loc

pub fn find_in_multiple<K>( ptr: *const u8, files: impl IntoIterator<Item = (K, impl AsRef<str>)>, ) -> Option<(K, Self)>

Same as find, but searches in multiple “files”.

A file, per definition of this function, is a key K that identifies it, and a memory range that is its content. The function returns the key of the file where ptr is contained, or None if no files matched.

use std::collections::HashMap;
use shrimple_parser::{Location, nonzero, tuple::copied};

let file2 = "          \n\nfn main() { panic!() }";
let sources = HashMap::from([
    ("file1.rs", r#"fn main() { println!("Hiiiii!!!!! :3") }"#),
    ("file2.rs", file2),
]);
let no_ws = file2.trim();
assert_eq!(
    Location::find_in_multiple(no_ws.as_ptr(), sources.iter().map(copied)),
    Some(("file2.rs", Location { line: nonzero!(3), col: 0 })),
)

Also see [tuple::copied], nonzero

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

Available on crate feature proc-macro2 only.

fn from(value: Location) -> 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 TryFrom<LineColumn> for Location

Available on crate feature proc-macro2 only.

type Error = LineColumnToLocationError

The type returned in the event of a conversion error.

fn try_from(value: LineColumn) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Location

impl Eq for Location

impl StructuralPartialEq for Location