Struct kserd::parse::Error

pub struct Error<'a> { /* fields omitted */ }

A hierarchy of errors which provide a trace of where the error originates.

As Kserds are nested, errors may occur inside other structures, creating a hierarchy of locations where errors originate from. ParseErr holds this hierarchy and can provide traces and a backtrace string to better understand the error.

Methods

impl<'a> Error<'a>

pub fn get(&self, index: usize) -> Option<Trace<'a>>

Get a Trace at the hierarchal error index.

pub fn iter<'i>(&'i self) -> impl Iterator<Item = Trace<'a>> + 'i

Iterate over the error hierarchy.

pub fn len(&self) -> usize

The number of errors in the error hierarchy.

pub fn is_empty(&self) -> bool

No errors in the rror hierarchy.

pub fn backtrace(&self) -> String

Combine the error into a backtrace.

Example

let string = "
list = [
           (0,1)
           (2,3]
       ]
";

let fail = kserd::parse::parse(string).unwrap_err();

assert_eq!(
&fail.backtrace(),
r##"#0: at 4:16 :: expected ')', found ']'
           (2,3]
               ^

#1: at 4:13 :: in inline tuple
           (2,3]
            ^

#2: at 2:9 :: in newline separated (concise) kserds
list = [
        ^

#3: at 2:9 :: in concise sequence
list = [
        ^

#4: at 2:1 :: in kserdstr-kserd key-value pair
list = [
^"##
);

Trait Implementations

impl<'a> Debug for Error<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Error<'a>> for Error<'a>

fn eq(&self, other: &Error<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Error<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Error<'a>