Struct json_pointer::JsonPointer

pub struct JsonPointer<S: AsRef<str>, C: AsRef<[S]>> { /* fields omitted */ }

A JSON Pointer.

Create a new JSON pointer with JsonPointer::new, or parse one from a string with str::parse().

Implementations

impl<S: AsRef<str>, C: AsRef<[S]>> JsonPointer<S, C>

pub fn new(ref_toks: C) -> JsonPointer<S, C>

Creates a new JsonPointer from the given reference tokens.

pub fn get<'json>(&self, val: &'json Value) -> Result<&'json Value, IndexError>

Attempts to get a reference to a value from the given JSON value, returning an error if it can't be found.

pub fn get_mut<'json>(
    &self,
    val: &'json mut Value
) -> Result<&'json mut Value, IndexError>

Attempts to get a mutable reference to a value from the given JSON value, returning an error if it can't be found.

pub fn get_owned(&self, val: Value) -> Result<Value, IndexError>

Attempts to get an owned value from the given JSON value, returning an error if it can't be found.

pub fn uri_fragment(&self) -> String

Converts a JSON pointer to a string in URI Fragment Identifier Representation, including the leading #.

impl<S: AsRef<str>> JsonPointer<S, Vec<S>>

pub fn push(&mut self, component: S)

Adds a component to the JSON pointer.

pub fn pop(&mut self) -> Option<S>

Removes and returns the last component from the JSON pointer.

Trait Implementations

impl<S: Clone + AsRef<str>, C: Clone + AsRef<[S]>> Clone for JsonPointer<S, C>

fn clone(&self) -> JsonPointer<S, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + AsRef<str>, C: Debug + AsRef<[S]>> Debug for JsonPointer<S, C>

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

Formats the value using the given formatter.

impl<S: AsRef<str>, C: AsRef<[S]>> Display for JsonPointer<S, C>

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

Formats the value using the given formatter.

impl<S: Eq + AsRef<str>, C: Eq + AsRef<[S]>> Eq for JsonPointer<S, C>

impl FromStr for JsonPointer<String, Vec<String>>

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a, S: AsRef<str>, C: AsRef<[S]>> Index<&'a JsonPointer<S, C>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, ptr: &'a JsonPointer<S, C>) -> &Value

Performs the indexing (container[index]) operation.

impl<'a, S: AsRef<str>, C: AsRef<[S]>> IndexMut<&'a JsonPointer<S, C>> for Value

fn index_mut(&mut self, ptr: &'a JsonPointer<S, C>) -> &mut Value

Performs the mutable indexing (container[index]) operation.

impl<S: PartialEq + AsRef<str>, C: PartialEq + AsRef<[S]>> PartialEq<JsonPointer<S, C>> for JsonPointer<S, C>

fn eq(&self, other: &JsonPointer<S, C>) -> bool

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

fn ne(&self, other: &JsonPointer<S, C>) -> bool

This method tests for !=.

impl<S: AsRef<str>, C: AsRef<[S]>> StructuralEq for JsonPointer<S, C>

impl<S: AsRef<str>, C: AsRef<[S]>> StructuralPartialEq for JsonPointer<S, C>