Struct JsonArray 

pub struct JsonArray<Values> { /* private fields */ }

JsonObject represents an RFC 8259 JSON Array. It wraps a mutable or immutable buffer of JSON values. The easiest way to use it is through the ArrayJsonArray type alias, however you can use JsonArray directly to wrap your own buffer like a heap allocated Vec.

Implementations

impl<T> JsonArray<T>

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

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

impl<'a, T: ValueBuffer<'a>> JsonArray<T>

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

wrap a collection of values into a JsonArray and considers none of the values to be initialized

pub fn wrap_init(values: 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 values in this JsonArray. Same as self.values().len()

pub fn capacity(&self) -> usize

get the max number of values this JsonArray can store

pub fn values(&self) -> &[JsonValue<'a>]

get an immutable reference to the initialized values of this JsonArray

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

attempt to serialize this JsonArray into the provided output & returns the number of bytes written on success

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

attempt to serialize this JsonArray into the provided output starting from resume_from & returns the number of bytes written on both success & failure

impl<'a, T: ValueBufferMut<'a>> JsonArray<T>

pub fn values_mut(&mut self) -> &mut [JsonValue<'a>]

get a mutable reference to the initialized fields of this JsonObject

pub fn push<V: Into<JsonValue<'a>>>(&mut self, value: V) -> Result<(), ()>

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

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

attempt to pop an existing value - returns None if there are no initialized values

pub fn parse( &mut self, data: &'a [u8], string_escape_buffer: &'a mut [u8], ) -> Result<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, const N: usize> JsonArray<[JsonValue<'a>; N]>

pub const fn new() -> Self

convenience method to initialize a new array & call JsonObject::wrap on it

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

convenience method to automatically create an ArrayJsonObject if object parsing is successful similar to JsonObject::push but supports const contexts & only returns a reference

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

similar to JsonObject::pop but supports const contexts

pub const fn values_const(&self) -> &[JsonValue<'a>]

same as JsonObject::fields but supports const contexts

pub const fn values_mut_const(&mut self) -> &mut [JsonValue<'a>]

same as JsonObject::fields_mut but supports const contexts

Trait Implementations

impl<Values: Clone> Clone for JsonArray<Values>

fn clone(&self) -> JsonArray<Values>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Values: Debug> Debug for JsonArray<Values>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: ValueBuffer<'a>> Display for JsonArray<T>

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

Formats the value using the given formatter.

impl<Values: Copy> Copy for JsonArray<Values>