Struct json_spanned_value::spanned::Spanned

pub struct Spanned<V> { /* fields omitted */ }

A value with start/end position information. Can wrap arbitrary Deserializeable JSON values, not just basic JSON types.

Implementations

impl<V> Spanned<V>

pub fn start(&self) -> usize

Get the starting byte offset (inclusive) of this value. Likely 0 unless loaded through crate::from_*.

pub fn end(&self) -> usize

Get the ending byte offset (non-inclusive) of this value. Likely 0 unless loaded through crate::from_*.

pub fn span(&self) -> (usize, usize)

Get the start .. end byte offset of this value as a (start, end) tuple. Likely (0, 0) unless loaded through crate::from_*.

pub fn range(&self) -> Range<usize>

Get the start .. end byte offset of this value as a start .. end Range. Likely 0 .. 0 unless loaded through crate::from_*.

pub fn into_inner(self) -> V

Get the interior value of the spanned region as an owned value.

pub fn get_ref(&self) -> &V

Get the interior value of the spanned region as a reference.

pub fn get_mut(&mut self) -> &mut V

Get the interior value of the spanned region as a mutable/exclusive reference.

impl Spanned<Value>

Various conversion methods:

• as_span_[type]() returns borrowing Options of some sort.
• into_span_[type]() returns Ok(type) or Err(original).

See also on super::Value as provided by Deref implementation:

• is_[type]() returns bools with obvious meanings.
• as_[type]() for borrowing Options without span info.
• into_[type]() for Ok(type) without span info, or Err(original).

pub fn as_span_null(&self) -> Option<Null>

Some(span + ()) if self is null`

pub fn as_span_bool(&self) -> Option<Bool>

Some(span + inner) if self is true or false

pub fn as_span_number(&self) -> Option<Num<'_>>

Some(span + &inner) if self is a number like 123

pub fn as_span_string(&self) -> Option<Str<'_>>

Some(span + &inner) if self is a string like "asdf"

pub fn as_span_array(&self) -> Option<Span<'_>>

Some(span + &inner) if self is an array like [1, 2, 3]

pub fn as_span_object(&self) -> Option<Obj<'_>>

Some(span + &inner) if self is an object like {"a": 1, "b": 2}

pub fn into_span_null(self) -> Result<Null, Self>

Ok(span + ()) if self is null, otherwise Err(self)

pub fn into_span_bool(self) -> Result<Bool, Self>

Ok(span + inner) if self is true or false, otherwise Err(self)

pub fn into_span_number(self) -> Result<Number, Self>

Ok(span + inner) if self is a number like 123, otherwise Err(self)

pub fn into_span_string(self) -> Result<String, Self>

Ok(span + inner) if self is a string like "asdf", otherwise Err(self)

pub fn into_span_array(self) -> Result<Array, Self>

Ok(span + inner) if self is an array like [1, 2, 3], otherwise Err(self)

pub fn into_span_object(self) -> Result<Object, Self>

Ok(span + inner) if self is an object like {"a": 1, "b": 2}, otherwise Err(self)

pub fn pointer(&self, path: &str) -> Option<&Value>

Lookup a value by JSON Pointer (RFC 6901)

pub fn pointer_mut(&mut self, path: &str) -> Option<&mut Value>

Lookup a value by JSON Pointer (RFC 6901)

Trait Implementations

impl<R, V: AsRef<R>> AsRef<R> for Spanned<V>

fn as_ref(&self) -> &R

Performs the conversion.

impl<V: Clone> Clone for Spanned<V>

fn clone(&self) -> Spanned<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Spanned<V>

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

Formats the value using the given formatter.

impl<V> Deref for Spanned<V>

fn deref(&self) -> &Self::Target

Dereferences the value.

type Target = V

The resulting type after dereferencing.

impl<'de, V: Deserialize<'de>> Deserialize<'de> for Spanned<V>

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

Deserialize this value from the given Serde deserializer.

impl<V: Display> Display for Spanned<V>

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

Formats the value using the given formatter.

impl<V: Eq> Eq for Spanned<V>

impl<V> From<V> for Spanned<V>

fn from(v: V) -> Self

Performs the conversion.

impl<V: Hash> Hash for Spanned<V>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, K: Hash + Ord + 'a, V: 'a> IntoIterator for &'a Spanned<Map<K, V>>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = <&'a IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K: Hash + Ord + 'a, V: 'a> IntoIterator for &'a mut Spanned<Map<K, V>>

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = <&'a mut IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Hash + Ord, V> IntoIterator for Spanned<Map<K, V>>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = <IndexMap<K, V> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V: Ord> Ord for Spanned<V>

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<V: PartialEq> PartialEq<Spanned<V>> for Spanned<V>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<V: PartialOrd> PartialOrd<Spanned<V>> for Spanned<V>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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