Struct JsonObject 

pub struct JsonObject<Fields> { /* private fields */ }

a JSON Object (rfc8259) that wraps a mutable or immutable buffer of object fields. The easiest way to use it is through the ArrayJsonObject type alias, however you can use JsonObject directly to wrap your own buffer like a heap allocated Vec

Implementations

impl<T> JsonObject<T>

pub fn into_inner(self) -> (T, usize)

consume this JsonObject to return (field buffer, num fields considered initialized)

impl<'a, T: FieldBuffer<'a>> JsonObject<T>

(re-export from embedded-io-adapters)

pub const fn wrap(fields: T) -> Self

wrap a collection of fields into a JsonObject and considers none of the fields to be initialized

pub fn wrap_init(fields: T) -> Self

wrap a collection of fields into a JsonObject and considers all of the fields to be initialized

pub const fn len(&self) -> usize

get the number of initialized fields in this JsonObject. Same as self.fields().len().

pub fn capacity(&self) -> usize

get the max number of fields this JsonObject can store.

pub fn fields(&self) -> &[JsonField<'a, 'a>]

get an immutable reference to the initialized fields of this JsonObject

pub fn serialize_into<Output: Write>( &self, output: Output, ) -> Result<usize, Output::Error>

attempt to serialize this JsonObject into the provided output, returns the number of bytes written on success

impl<'a, T: FieldBufferMut<'a>> JsonObject<T>

pub fn fields_mut(&mut self) -> &mut [JsonField<'a, 'a>]

get a mutable reference to the initialized fields of this JsonObject

pub fn push<'x: 'a, 'y: 'a>( &mut self, field: JsonField<'x, 'y>, ) -> Result<(), JsonField<'x, 'y>>

attempt to push a new field - returns the field if there is not enough space

pub fn pop(&mut self) -> Option<JsonField<'a, 'a>>

attempt to pop an existing field - returns None if there are no initialized fields

pub fn push_field<'x: 'a, 'y: 'a>( &mut self, key: &'x str, value: JsonValue<'y>, ) -> Result<(), ()>

convenience helper to create and push a new field

pub fn parse( &mut self, data: &'a [u8], ) -> Result<(usize, usize), JsonParseFailure>

attempt to parse a JSON object from the provided data slice and write its fields into this JsonObject - returns a tuple of (num bytes consumed, num fields parsed) on success

impl<'a, T: FieldBufferMut<'a> + Default> JsonObject<T>

pub fn default_parsed(data: &'a [u8]) -> Result<(usize, Self), JsonParseFailure>

convenience method to automatically create an JsonObject if object parsing is successful

impl<'a, const N: usize> JsonObject<[JsonField<'a, 'a>; N]>

pub const fn new() -> Self

convenience method to call JsonObject::wrap on a new array

pub fn new_parsed(data: &'a [u8]) -> Result<(usize, Self), JsonParseFailure>

convenience method to automatically create an ArrayJsonObject if object parsing is successful

pub const fn push_const( &mut self, key: &'a str, value: JsonValue<'a>, ) -> Result<(), ()>

similar to JsonObject::push but supports const contexts & only returns a reference

pub const fn pop_const(&mut self) -> Option<&JsonField<'a, 'a>>

similar to JsonObject::pop but supports const contexts

pub const fn fields_const(&self) -> &[JsonField<'a, 'a>]

same as JsonObject::fields but supports const contexts

pub const fn fields_mut_const(&mut self) -> &mut [JsonField<'a, 'a>]

same as JsonObject::fields_mut but supports const contexts

Trait Implementations

impl<Fields: Debug> Debug for JsonObject<Fields>

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

Formats the value using the given formatter.

impl<'a, T: FieldBuffer<'a> + Default + ?Sized> Default for JsonObject<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: FieldBuffer<'a>> From<T> for JsonObject<T>

fn from(field_buffer: T) -> Self

Converts to this type from the input type.