Struct Location

pub struct Location {
    pub line: usize,
    pub column: usize,
}

A location in a string where an error may have occurred. In keeping with the typical practice from editors and other tools, line and columns are both 1-indexed.

Example

use nom_supreme::final_parser::{RecreateContext, Location};

let original_input = "Hello,\nWorld!\n";
let tail = &original_input[9..];

assert_eq!(
   Location::recreate_context(original_input, tail),
   Location { line: 2, column: 3 },
);

Fields

line: usize

The line number in the original input where the error occurred

column: usize

The column of the line in the original input where the error occurred

Implementations

impl Location

pub fn locate_tail<'a>(original_input: &'a str, tail: &'a str) -> Self

Given the original input string, as well as the context reported by nom, compute the location in the original string where the error occurred.

This function will report garbage (and may panic) if the context is not associated with the input

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy 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 Display for Location

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

Formats the value using the given formatter.

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 RecreateContext<&str> for Location

fn recreate_context(original_input: &str, tail: &str) -> Self

Given the original input, as well as the context reported by nom, recreate a context in the original string where the error occurred.

impl Copy for Location

impl Eq for Location

impl StructuralPartialEq for Location