Struct Location 

pub struct Location { /* private fields */ }

Row/column location within the source YAML document (1-indexed, character-based).

This type is used for both:

• deserialization error reporting ([crate::Error])
• span-aware values (crate::Spanned)

Example

use serde::Deserialize;

#[derive(Deserialize, Debug)]
struct Doc {
    val: String,
}

// 1. Parse invalid YAML (type mismatch: expected string, found sequence)
// Due emoji character and byte offsets are different.
let yaml = "val🔑: [1, 2]";
let err: Result<Doc, _> = serde_saphyr::from_str(yaml);

// 2. Obtain the error and its location
if let Err(e) = err {
    if let Some(loc) = e.location() {
        // 3. Print row, column, and byte offsets
        // Output: Error at line 1, col 7. Byte offset: 9
        println!("Error at line {}, col {}", loc.line(), loc.column());
        if let Some(byte_off) = loc.span().byte_offset() {
            println!("Byte offset: {}", byte_off);
        }
    }
}

Implementations

impl Location

pub fn line(&self) -> u64

serde_yaml-compatible line information.

pub fn column(&self) -> u64

serde_yaml-compatible column information.

pub fn span(&self) -> Span

Character-based span within the source document. For string source, it also can provide byte offsets.

pub fn source_id(&self) -> u32

Numeric id of the source.

impl Location

pub const UNKNOWN: Self

Sentinel value meaning “location unknown”.

Used when a precise position is not yet available at error creation time.

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

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 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: &Location) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Location