Enum ParseError

pub enum ParseError {
    NoLeadingSlash,
    InvalidEncoding {
        offset: usize,
        source: EncodingError,
    },
}

Indicates that a Pointer was malformed and unable to be parsed.

Variants

NoLeadingSlash

Pointer did not start with a slash ('/').

InvalidEncoding

Pointer contained invalid encoding (e.g. ~ not followed by 0 or 1).

Fields

offset: usize

Offset of the partial pointer starting with the token that contained the invalid encoding

source: EncodingError

The source InvalidEncodingError

Implementations

impl ParseError

pub fn offset(&self) -> usize

Offset of the partial pointer starting with the token that contained the invalid encoding

pub fn invalid_encoding_len(&self, subject: &str) -> usize

Length of the invalid encoding

impl ParseError

pub fn is_no_leading_backslash(&self) -> bool

👎Deprecated since 0.7.0: renamed to is_no_leading_slash

Returns true if this error is NoLeadingSlash

pub fn is_no_leading_slash(&self) -> bool

Returns true if this error is NoLeadingSlash

pub fn is_invalid_encoding(&self) -> bool

Returns true if this error is InvalidEncoding

pub fn pointer_offset(&self) -> usize

Offset of the partial pointer starting with the token which caused the error.

"/foo/invalid~tilde/invalid"
     ↑

let err = PointerBuf::parse("/foo/invalid~tilde/invalid").unwrap_err();
assert_eq!(err.pointer_offset(), 4)

pub fn source_offset(&self) -> usize

Offset of the character index from within the first token of Self::pointer_offset)

"/foo/invalid~tilde/invalid"
             ↑
             8

let err = PointerBuf::parse("/foo/invalid~tilde/invalid").unwrap_err();
assert_eq!(err.source_offset(), 8)

pub fn complete_offset(&self) -> usize

Offset of the first invalid encoding from within the pointer.

"/foo/invalid~tilde/invalid"
             ↑
            12

use jsonptr::PointerBuf;
let err = PointerBuf::parse("/foo/invalid~tilde/invalid").unwrap_err();
assert_eq!(err.complete_offset(), 12)

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Diagnostic for ParseError

type Subject = String

The value which caused the error.

fn url() -> &'static str

The docs.rs URL for this error

fn labels( &self, subject: &Self::Subject, ) -> Option<Box<dyn Iterator<Item = Label>>>

Returns the label for the given [Subject] if applicable.

fn into_report(self, subject: impl Into<Self::Subject>) -> Report<Self>

Combine the error with its subject to generate a Report.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ParseError

fn eq(&self, other: &ParseError) -> 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 StructuralPartialEq for ParseError