Struct Token

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

A Token is a segment of a JSON Pointer, preceded by '/' (%x2F).

Tokens can represent a key in a JSON object or an index in an array.

• Indexes should not contain leading zeros.
• When dealing with arrays or path expansion for assignment, "-" represent the next, non-existent index in a JSON array.

Implementations

impl<'a> Token<'a>

pub fn from_encoded(s: &'a str) -> Result<Self, EncodingError>

Constructs a Token from an RFC 6901 encoded string.

To be valid, the string must not contain any / characters, and any ~ characters must be followed by either 0 or 1.

This function does not allocate.

Examples

assert_eq!(Token::from_encoded("~1foo~1~0bar").unwrap().decoded(), "/foo/~bar");
let err = Token::from_encoded("foo/oops~bar").unwrap_err();
assert_eq!(err.offset, 3);

Errors

Returns InvalidEncodingError if the input string is not a valid RFC 6901 (~ must be followed by 0 or 1)

pub fn new(s: impl Into<Cow<'a, str>>) -> Self

Constructs a Token from an arbitrary string.

If the string contains a / or a ~, then it will be assumed not encoded, in which case this function will encode it, allocating a new string.

If the string is already encoded per RFC 6901, use Self::from_encoded instead, otherwise it will end up double-encoded.

Examples

assert_eq!(Token::new("/foo/~bar").encoded(), "~1foo~1~0bar");

pub fn into_owned(self) -> Token<'static>

Converts into an owned copy of this token.

If the token is not already owned, this will clone the referenced string slice.

pub fn to_owned(&self) -> Token<'static>

Extracts an owned copy of this token.

If the token is not already owned, this will clone the referenced string slice.

This method is like Self::into_owned, except it doesn’t take ownership of the original Token.

pub fn encoded(&self) -> &str

Returns the encoded string representation of the Token.

Examples

assert_eq!(Token::new("~bar").encoded(), "~0bar");

pub fn decoded(&self) -> Cow<'_, str>

Returns the decoded string representation of the Token.

Examples

assert_eq!(Token::new("~bar").decoded(), "~bar");

pub fn to_index(&self) -> Result<Index, ParseIndexError>

Attempts to parse the given Token as an array index.

Per RFC 6901, the acceptable values are non-negative integers and the - character, which stands for the next, non-existent member after the last array element.

Examples

assert_eq!(Token::new("-").to_index(), Ok(Index::Next));
assert_eq!(Token::new("0").to_index(), Ok(Index::Num(0)));
assert_eq!(Token::new("2").to_index(), Ok(Index::Num(2)));
assert!(Token::new("a").to_index().is_err());
assert!(Token::new("-1").to_index().is_err());

Errors

Returns ParseIndexError if the token is not a valid array index.

pub fn is_next(&self) -> bool

Returns if the Token is -, which stands for the next array index.

See also Self::to_index.

Trait Implementations

impl<'a> Clone for Token<'a>

fn clone(&self) -> Token<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Token<'a>

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

Formats the value using the given formatter.

impl Display for Token<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a String> for Token<'a>

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

Converts to this type from the input type.

impl<'a> From<&Token<'a>> for Token<'a>

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

Converts to this type from the input type.

impl<'a> From<&'a str> for Token<'a>

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

Converts to this type from the input type.

impl From<String> for Token<'static>

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Token<'_>> for PointerBuf

fn from(t: Token<'_>) -> Self

Converts to this type from the input type.

impl<'t> From<Token<'t>> for Component<'t>

fn from(token: Token<'t>) -> Self

Converts to this type from the input type.

impl From<i128> for Token<'static>

fn from(v: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Token<'static>

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Token<'static>

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Token<'static>

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Token<'static>

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Token<'static>

fn from(v: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Token<'static>

fn from(v: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Token<'static>

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Token<'static>

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Token<'static>

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Token<'static>

fn from(v: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Token<'static>

fn from(v: usize) -> Self

Converts to this type from the input type.

impl<'a> Hash for Token<'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> Ord for Token<'a>

fn cmp(&self, other: &Token<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Token<'a>

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

fn partial_cmp(&self, other: &Token<'a>) -> 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 TryFrom<&Token<'_>> for Index

type Error = ParseIndexError

The type returned in the event of a conversion error.

fn try_from(value: &Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Token<'_>> for Index

type Error = ParseIndexError

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Token<'a>

impl<'a> StructuralPartialEq for Token<'a>