Struct json_writer::JSONArrayWriter

pub struct JSONArrayWriter<'a> {
    pub buffer: &'a mut String,
    // some fields omitted
}

Helper for appending a JSON array to the borrowed buffer.

Appends ‘[’ on creation. Appends ‘]’ when dropped.

Fields

buffer: &'a mut String

Mutable borrow of buffer

Consider using the methods instead of using this field directly. This field should not be used unless you know what you are doing.

Implementations

impl JSONArrayWriter<'_>

pub fn new<'a>(buffer: &'a mut String) -> JSONArrayWriter<'a>

Creates a new JSONArrayWriter that writes to the given buffer. Writes ‘[’ to the buffer immediately.

pub fn object<'a>(&'a mut self) -> JSONObjectWriter<'a>

Starts writing a nested object as array entry.

Writes ‘{’ and returns a JSONObjectWriter

pub fn array<'a>(&'a mut self) -> JSONArrayWriter<'a>

Starts writing a nested array as array entry.

Writes ‘[’ and returns a JSONArrayWriter

pub fn value<T: JSONWriterValue>(&mut self, value: T)

Writes given value as array entry

pub fn write_comma(&mut self)

Writes a comma unless at the beginning of the array

Warning: If you use this method, you will have to write the value to the buffer youself afterwards.

pub fn end(self)

Drops the writer. Dropping causes ‘]’ to be appended to the buffer.

pub fn output_buffered_data<Writer: Write>(
    &mut self,
    writer: &mut Writer
) -> Result<usize, Error>

Writes the entire buffer to given writer and clears entire buffer on success.

pub fn buffer_len(&self) -> usize

Returns buffer length in bytes

Trait Implementations

impl Drop for JSONArrayWriter<'_>

fn drop(&mut self)

Executes the destructor for this type.