Struct Element 

pub struct Element<'buf> { /* private fields */ }

A JSON Element with identity, source span, and value.

Each element carries a shared reference to the document it was parsed from, so Element::path() can resolve its path.

Implementations

impl<'buf> Element<'buf>

pub fn id(&self) -> ElemId

Returns this element’s identity within its Document.

pub fn span(&self) -> Span

Returns the span covering this element’s value alone, without any trailing comma.

See Element::full_span for the span that reaches the next sibling.

pub fn full_span(&self) -> Span

Returns the span covering the value plus any trailing comma and the whitespace after it, so the span ends where the next sibling begins.

When there is no trailing comma (the root element, or the last child of its parent), full_span() == span().

Use Element::span to replace a value. Removal is not simply a matter of erasing full_span: which span removes a child depends on which of its siblings survive, and erasing the full_span of a last child leaves a dangling comma on the sibling before it. Use Document::removal_spans, which resolves a whole set of removals against the surviving siblings.

pub fn value(&self) -> &Value<'buf>

Returns this element’s JSON value.

pub fn path(&self) -> Path

Returns the RFC 9535 path to this element.

NOTE: The Path is constructed anew every time this functions is called.

pub fn source_json_value(&self) -> &'buf str

Returns the slice of the source JSON that this element spans.

pub fn source(&self) -> &'buf str

The full source string; all element spans are relative to this.

pub fn location(&self) -> Location

Return the location that this element begins at.

pub fn as_value(&self) -> &Value<'buf>

Return the inner Value by ref.

pub fn to_raw_str(&self) -> Option<RawStr<'buf>>

Return Some(&str) if the Value is a String.

pub fn as_object_fields(&self) -> Option<&[Field<'buf>]>

Return Some(&[Field]) if the Value is a Object.

pub fn as_array(&self) -> Option<&[Element<'buf>]>

Returns the items if this element is a JSON array, None otherwise.

pub fn as_number_str(&self) -> Option<&str>

Returns the number as it was written in the source if this element is a JSON number, None otherwise. The text is not parsed, so it keeps the precision the document had.

pub fn is_null(&self) -> bool

Return true if the Elements Value is null.

pub fn is_object(&self) -> bool

Return true if the Elements Value is an object.

pub fn is_array(&self) -> bool

Return true if the Elements Value is an array.

Trait Implementations

impl<'buf> Clone for Element<'buf>

fn clone(&self) -> Element<'buf>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'buf> Debug for Element<'buf>

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

Formats the value using the given formatter.

impl Eq for Element<'_>

impl PartialEq for Element<'_>

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

Equality operator ==.

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

Inequality operator !=.