Struct JsonPointer

pub struct JsonPointer<'a> { /* private fields */ }

A structure representing a complete pointer, comprising multiple JsonPointerComponents

Implementations

impl<'a> JsonPointer<'a>

pub fn root() -> Self

Returns a root JsonPointer instance

pub fn is_root(&self) -> bool

Checks to see if a pointer is just a top level root element

pub fn len(&self) -> usize

Returns the number of JsonPointerComponents within the pointer

pub fn is_empty(&self) -> bool

Checks whether the pointer is the empty pointer

pub fn push_names(&mut self, names: &[&'a str])

Push a whole bunch of names onto the end of the path in order

pub fn push_indexes(&mut self, indexes: &[usize])

Push a whole bunch of indexes onto the end of the path in order

pub fn push_name(&mut self, name: String)

Push a new JsonPointerComponent::Name onto the end of the pointer

pub fn push_index(&mut self, index: usize)

Push a new JsonPointerComponent::Index onto the end of the pointer

pub fn pop(&mut self) -> Option<JsonPointerComponent<'a>>

Pop the last component off the back of the pointer

pub fn matches(&self, rhs: &'a JsonPointer<'_>) -> bool

Checks whether a path matches another path.

pub fn as_str(&self) -> Cow<'a, str>

Serialise the pointer into a string representation that’s compliant with RFC 6901

Trait Implementations

impl<'a> Add<&JsonPointer<'a>> for JsonPointer<'a>

fn add(self, rhs: &JsonPointer<'a>) -> Self

Concatenate two JsonPointer instances.

type Output = JsonPointer<'a>

The resulting type after applying the + operator.

impl<'a> Debug for JsonPointer<'a>

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

Formats the value using the given formatter.

impl<'a> Default for JsonPointer<'a>

fn default() -> JsonPointer<'a>

Returns the “default value” for a type.

impl<'a> Display for JsonPointer<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for JsonPointer<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for JsonPointer<'a>

fn eq(&self, other: &Self) -> 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<'a> Eq for JsonPointer<'a>