Struct JsonPointer 

pub struct JsonPointer { /* private fields */ }

A JSON Pointer (RFC 6901): identifies a value within a JSON document.

Stored as decoded segments; the pointer string is produced by encoding when needed. Root has zero segments.

Implementations

impl JsonPointer

pub fn root() -> Self

Root pointer (whole document). Equal to the empty string.

pub fn push(&self, segment: &str) -> Self

Returns a new pointer with one more segment. The segment is stored decoded; encoding is applied when producing the pointer string.

pub fn pop(&self) -> Self

Returns a new pointer with the last segment removed. Root unchanged.

pub fn parent(&self) -> Self

Returns the parent pointer (same as popping the last segment).

pub fn truncate(&self, len: usize) -> Self

Returns a new pointer with only the first len segments.

pub fn len(&self) -> usize

Number of segments (0 for root).

pub fn is_empty(&self) -> bool

Returns true if this pointer has no segments (root).

pub fn is_root(&self) -> bool

Returns true if this is the root pointer.

pub fn segments(&self) -> impl Iterator<Item = &str>

Returns an iterator over the decoded segments.

pub fn segment_at(&self, index: usize) -> Option<&str>

Returns the segment at index, or None if out of bounds.

pub fn remove(&self, index: usize) -> Self

Returns a new pointer with the segment at index removed.

pub fn as_str(&self) -> &str

Returns the pointer as a string (“” for root, “/a/b” for children).

pub fn display_root_or_path(&self) -> &str

Returns a display-friendly location: “root” when empty, otherwise the pointer string.

Trait Implementations

impl Clone for JsonPointer

fn clone(&self) -> JsonPointer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 From<JsonPointer> for String

fn from(p: JsonPointer) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for JsonPointer

fn from(segments: Vec<String>) -> Self

Converts to this type from the input type.

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 TryFrom<&[u8]> for JsonPointer

type Error = JsonPointerError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for JsonPointer

type Error = JsonPointerError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for JsonPointer

type Error = JsonPointerError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for JsonPointer

type Error = JsonPointerError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for JsonPointer

impl StructuralPartialEq for JsonPointer