Struct Doc 

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

A value with the key table its keys are interned against.

Everything a Value offers is here too, and the things that need a name rather than an id, which are a lookup, a walk over the members and printing the thing, go through the table. A document whose keys are bytes works the same way and simply never asks the table anything, so a caller does not have to know which kind it is holding.

Implementations

impl<'a> Doc<'a>

pub fn new(value: Value<'a>, keys: &'a Keys) -> Doc<'a>

A view of value against keys.

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

The value underneath, for the accessors that never need a name.

pub fn keys(&self) -> &'a Keys

The key table this reads names out of.

pub fn kind(&self) -> Kind

What this value is.

pub fn is_null(&self) -> bool

Whether this is null.

pub fn as_bool(&self) -> Option<bool>

The boolean this holds, if it holds one.

pub fn as_int(&self) -> Option<i64>

The integer this holds, if it holds one.

pub fn as_float(&self) -> Option<f64>

The float this holds, if it holds one.

pub fn as_text(&self) -> Option<&'a str>

The string this holds, if it holds one and it is UTF-8.

pub fn text_bytes(&self) -> Option<&'a [u8]>

The string this holds as it is stored, without the UTF-8 check.

pub fn len(&self) -> usize

How many elements a container holds. Zero for anything else.

pub fn is_empty(&self) -> bool

Whether this is a container with nothing in it.

pub fn get(&self, key: &[u8]) -> Option<Doc<'a>>

The value stored under key.

For an interned object this is a name to id lookup in the table and then a binary search over integers. A name the table has never seen cannot be in the document, so it answers None without touching the document at all.

pub fn at(&self, i: usize) -> Option<Doc<'a>>

Element i of a container, in the container’s own order.

pub fn key_at(&self, i: usize) -> Option<&'a [u8]>

The name of member i of an object, whichever way the keys are stored.

pub fn members(&self) -> DocMembers<'a>

Every member of an object, name first, in the order the document stores them.

That order is by key id for an interned object and by key bytes for one whose keys are bytes, so it is stable for a given collection and it is not alphabetical. Sort it if the order is part of the answer.

pub fn iter(&self) -> DocElems<'a>

Every element of a container, in the container’s own order.

pub fn path(&self, path: &str) -> Result<Option<Doc<'a>>, Error>

The value at path, where a path names exactly one place.

The same grammar Value::path takes, with the names resolved through the key table on the way down.

pub fn path_bytes(&self, path: &[u8]) -> Result<Option<Doc<'a>>, Error>

Doc::path for a path that is already bytes.

Trait Implementations

impl<'a> Clone for Doc<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Doc<'a>

impl Debug for Doc<'_>

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

Formats the value using the given formatter.