Struct JsonPointer 

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

JSON Pointer.

See: https://datatracker.ietf.org/doc/html/rfc6901

Implementations

impl JsonPointer

pub const ROOT: &'static Self

pub fn new<S>(s: &S) -> Result<&Self, InvalidJsonPointer<&S>>

where S: AsRef<[u8]> + ?Sized,

Converts the given string into a JSON pointer.

pub const fn from_str_const(s: &str) -> Result<&Self, InvalidJsonPointer<&str>>

pub const unsafe fn new_unchecked_str(s: &str) -> &Self

Converts the given string into a JSON pointer without validation.

Safety

The input string must be a valid JSON pointer.

pub const unsafe fn new_unchecked(s: &[u8]) -> &Self

Converts the given string into a JSON pointer without validation.

Safety

The input string must be a valid JSON pointer.

pub const fn validate_bytes(s: &[u8]) -> bool

Confirms the validity of a string such that it may be safely used for Self::new_unchecked.

pub const fn validate_str(s: &str) -> bool

Confirms the validity of a string such that it may be safely used for Self::new_unchecked_str.

pub fn as_bytes(&self) -> &[u8]

pub fn as_str(&self) -> &str

pub fn is_empty(&self) -> bool

pub fn split_first(&self) -> Option<(&ReferenceToken, &Self)>

pub fn iter(&self) -> JsonPointerIter<'_>

Trait Implementations

impl AsRef<JsonPointer> for JsonPointer

fn as_ref(&self) -> &JsonPointer

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

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 Default for &JsonPointer

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for &'de JsonPointer

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JsonPointer

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

Formats the value using the given formatter.

impl Hash for JsonPointer

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

Feeds this value into the given Hasher.

impl<'a> IntoIterator for &'a JsonPointer

type Item = &'a ReferenceToken

The type of the elements being iterated over.

type IntoIter = JsonPointerIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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 Serialize for JsonPointer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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