Struct Location 

pub struct Location { /* private fields */ }

A (line, column, byte index) location in a YAML document.

line and column are 1-based for any Location produced by parsing or by Location::from_index / Location::new. The single exception is Location::default() (and the Spanned::new constructor it powers), which yields 0/0/0 as a sentinel for “not yet populated by a parser pass.” User code that only ever sees a Location returned from a parser may treat both axes as strictly ≥ 1.

index is always 0-based and counts UTF-8 bytes from the start of the document.

Examples

use noyalib::Location;
let loc = Location::from_index("a: 1\nb: 2\n", 5);
assert_eq!(loc.line(), 2);
assert_eq!(loc.column(), 1);

Implementations

impl Location

pub fn from_index(input: &str, index: usize) -> Location

Create a new location from a byte index.

Examples

use noyalib::Location;
let loc = Location::from_index("hello\nworld", 6);
assert_eq!(loc.line(), 2);

pub fn new(line: usize, col: usize, index: usize) -> Location

Create a new location from line, column, and byte index.

Examples

use noyalib::Location;
let loc = Location::new(1, 1, 0);
assert_eq!(loc.line(), 1);

pub fn index(&self) -> usize

The 0-based byte index.

Examples

use noyalib::Location;
let loc = Location::from_index("abc", 2);
assert_eq!(loc.index(), 2);

pub fn line(&self) -> usize

The 1-based line number.

Returns 0 only for a Location::default() that has not been populated by a parser pass; any Location produced by Location::from_index, Location::new, or returned from a parser is ≥ 1.

Examples

use noyalib::Location;
let loc = Location::from_index("a\nb", 2);
assert_eq!(loc.line(), 2);

pub fn column(&self) -> usize

The 1-based column number.

Returns 0 only for a Location::default() that has not been populated by a parser pass; any Location produced by Location::from_index, Location::new, or returned from a parser is ≥ 1.

Examples

use noyalib::Location;
let loc = Location::from_index("abcd", 3);
assert_eq!(loc.column(), 4);

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<(), Error>

Formats the value using the given formatter.

impl Default for Location

fn default() -> Location

Returns the “default value” for a type.

impl Display for Location

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

Formats the value using the given formatter.

impl Hash for Location

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

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

impl Eq for Location

impl StructuralPartialEq for Location