Struct JsonPointer 

pub struct JsonPointer(/* private fields */);

A JSON Pointer.

Implementations

impl JsonPointer

pub fn parse(s: &str) -> Result<&Self, JsonPointerSyntaxError>

Parses a pointer from an RFC 6901 string.

The empty string is the valid root pointer. All other strings must start with /.

pub fn empty() -> &'static Self

Returns the empty root pointer.

pub fn is_empty(&self) -> bool

Returns true if this is the empty root pointer.

pub fn head(&self) -> Option<&JsonPointerSegment>

Returns the first segment, or None for the root pointer.

pub fn tail(&self) -> &JsonPointer

Returns the pointer without its first segment.

For the root pointer, returns the root pointer.

pub fn segments(&self) -> JsonPointerSegments<'_>

Returns a borrowing iterator over the segments.

pub fn follow<'a, T: JsonPointerTarget<'a>>( &self, root: &'a (impl JsonPointee + ?Sized), ) -> Result<T, JsonPointerError>

Follows this pointer through root and extracts the result as T.

Trait Implementations

impl AsRef<JsonPointer> for JsonPointerBuf

fn as_ref(&self) -> &JsonPointer

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<JsonPointer> for JsonPointerBuf

fn borrow(&self) -> &JsonPointer

Immutably borrows from an owned value.

impl Debug for JsonPointer

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

Formats the value using the given formatter.

impl Display for JsonPointer

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

Formats the value using the given formatter.

impl<'a> From<&'a JsonPointer> for Cow<'a, JsonPointer>

fn from(value: &'a JsonPointer) -> Self

Converts to this type from the input type.

impl From<&JsonPointer> for JsonPointerBuf

fn from(value: &JsonPointer) -> Self

Converts to this type from the input type.

impl Hash for JsonPointer

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

Feeds this value into the given Hasher.

impl Ord for JsonPointer

fn cmp(&self, other: &JsonPointer) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for JsonPointer

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

fn partial_cmp(&self, other: &JsonPointer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToOwned for JsonPointer

type Owned = JsonPointerBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for JsonPointer

impl StructuralPartialEq for JsonPointer