Enum jsonptr::resolve::ResolveError

pub enum ResolveError {
    FailedToParseIndex {
        offset: usize,
        source: ParseIndexError,
    },
    OutOfBounds {
        offset: usize,
        source: OutOfBoundsError,
    },
    NotFound {
        offset: usize,
    },
    Unreachable {
        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

offset: usize

Offset of the partial pointer starting with the invalid index.

source: ParseIndexError

The source ParseIndexError

OutOfBounds

Pointer could not be resolved due to an index being out of bounds within an array.

Example

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

Fields

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

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

offset: usize

Offset of the pointer which was unreachable.

Implementations

impl ResolveError

pub fn offset(&self) -> usize

Offset of the partial pointer starting with 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 ResolveError

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

Formats the value using the given formatter.

impl Display for ResolveError

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

Formats the value using the given formatter.

impl Error for ResolveError

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

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 ResolveError

fn eq(&self, other: &ResolveError) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ResolveError

impl StructuralPartialEq for ResolveError