Struct Location 

#[non_exhaustive]
pub struct Location {
    pub absolute_start: usize,
    pub absolute_end: usize,
    pub start: Position,
    pub end: Position,
}

A Location represents a location in a document.

After parsing, line and column positions refer to the original source, including content from nested and partial includes. Each Position carries its own include chain in file; primary-input positions use None.

Byte offsets normally refer to each endpoint’s original file. Reindented includes are an exception: their byte offsets remain in preprocessed coordinates. Use the line and column to locate that content in its original file.

A span can cross files. Self::byte_len returns None in that case because the offsets use different coordinate spaces. JSON contains line, column, and include chain only; it omits byte offsets.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

absolute_start: usize

The absolute start position of the location.

absolute_end: usize

The absolute end position of the location.

start: Position

The start position of the location.

end: Position

The end position of the location.

Implementations

impl Location

pub fn point(position: Position) -> Self

A zero-width location at a single position (start == end), used for point diagnostics that only know a line/column. Byte offsets are 0.

pub fn byte_len(&self) -> Option<usize>

Byte length of this location (absolute_end - absolute_start + 1, end inclusive), but only when both boundaries are in the same file (start.file == end.file).

Returns None for a span that crosses a file boundary: its absolute_start and absolute_end live in different files’ coordinate spaces, so subtracting them is meaningless. Prefer this over subtracting absolute_* directly — it can’t silently produce a garbage length across files. For a cross-file span, locate each endpoint via its own file/line instead.

pub fn validate(&self, input: &str) -> Result<(), String>

Validates that this location satisfies all invariants.

Checks:

• absolute_start <= absolute_end (valid range)
• absolute_end <= input.len() (within bounds)
• Both offsets are on UTF-8 character boundaries

Errors

Returned as strings for easier debugging.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Self

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

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

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

Equality operator ==.

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

Inequality 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 StructuralPartialEq for Location