Enum Error

pub enum Error {
    FailedToParseIndex {
        position: usize,
        offset: usize,
        source: ParseIndexError,
    },
    OutOfBounds {
        position: usize,
        offset: usize,
        source: OutOfBoundsError,
    },
    NotFound {
        position: usize,
        offset: usize,
    },
    Unreachable {
        position: usize,
        offset: usize,
    },
}

Indicates that the Pointer could not be resolved.

Variants

FailedToParseIndex

Pointer could not be resolved because a Token for an array index is not a valid integer or dash ("-").

Example

let data = json!({ "foo": ["bar"] });
let ptr = Pointer::from_static("/foo/invalid");
assert!(ptr.resolve(&data).unwrap_err().is_failed_to_parse_index());

Fields

position: usize

Position (index) of the token which failed to parse as an Index

offset: usize

Offset of the partial pointer starting with the invalid index.

source: ParseIndexError

The source ParseIndexError

OutOfBounds

A Token within the Pointer contains an [Index] which is out of bounds.

Example

let data = json!({ "foo": ["bar"] });
let ptr = Pointer::from_static("/foo/1");
assert!(ptr.resolve(&data).unwrap_err().is_out_of_bounds());

Fields

position: usize

Position (index) of the token which failed to parse as an Index

offset: usize

Offset of the partial pointer starting with the invalid index.

source: OutOfBoundsError

The source OutOfBoundsError

NotFound

Pointer could not be resolved as a segment of the path was not found.

Example

let mut data = json!({ "foo": "bar" });
let ptr = Pointer::from_static("/bar");
assert!(ptr.resolve(&data).unwrap_err().is_not_found());

Fields

position: usize

Position (index) of the token which was not found.

offset: usize

Offset of the pointer starting with the Token which was not found.

Unreachable

Pointer could not be resolved as the path contains a scalar value before fully exhausting the path.

Example

let mut data = json!({ "foo": "bar" });
let ptr = Pointer::from_static("/foo/unreachable");
let err = ptr.resolve(&data).unwrap_err();
assert!(err.is_unreachable());

Fields

position: usize

Position (index) of the token which was unreachable.

offset: usize

Offset of the pointer which was unreachable.

Implementations

impl Error

pub fn offset(&self) -> usize

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

pub fn position(&self) -> usize

Position (index) of the token which caused the error.

pub fn is_unreachable(&self) -> bool

Returns true if this error is FailedToParseIndex; otherwise returns false.

pub fn is_not_found(&self) -> bool

Returns true if this error is FailedToParseIndex; otherwise returns false.

pub fn is_out_of_bounds(&self) -> bool

Returns true if this error is FailedToParseIndex; otherwise returns false.

pub fn is_failed_to_parse_index(&self) -> bool

Returns true if this error is FailedToParseIndex; otherwise returns false.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Diagnostic for Error

type Subject = PointerBuf

The value which caused the error.

fn url() -> &'static str

The docs.rs URL for this error

fn labels( &self, origin: &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 Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

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

impl StructuralPartialEq for Error