Struct Object

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

Container that stores its elements with numeric keys and provides get by key access. Keys are of &str type

Implementations

impl<'a> Object<'a>

pub fn add_value<'c, 'p: 'c, 'd>( &'p mut self, key: &str, value: impl AsValue<'d>, ) -> Result<Value<'c>, Error>

Adds new field with given name and value to this object

pub fn as_bytes(&self) -> &[u8]

Returns slice of bytes representing current document.

It’s guaranteed to be subslice of initial buffer and for root document it will starting at 0.

So by taking it’s len you can get how many bytes in buffer are used

pub fn count(&self) -> usize

Returns number of elements in this object

pub fn empty() -> Object<'static>

Returns new empty object

Object is read only so no new elements can be added to it

pub fn empty_mut(allocation: impl Into<Allocation<'a>>) -> Result<Self, Error>

Creates a new object that uses given allocation for storage

pub fn get(&self, key: &str) -> Option<Value<'_>>

Get value with specific key

pub fn iter(&self) -> impl Iterator<Item = (&str, Value<'_>)>

Iterate over elements of this object

Trait Implementations

impl<'a> Debug for Object<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Object<'a>

fn eq(&self, other: &Object<'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> TryFrom<Value<'a>> for Object<'a>

type Error = Value<'a>

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Object<'a>

impl<'a> StructuralPartialEq for Object<'a>