Struct JsonStreamWriter 

pub struct JsonStreamWriter<W>
where
    W: Write,
{ /* private fields */ }

A JSON writer implementation which writes data to a Write

This writer internally buffers data so it is normally not necessary to wrap the provided writer in a std::io::BufWriter.

The data written to the underlying writer will be valid UTF-8 data if the JSON document is finished properly by calling JsonWriter::finish_document. No leading byte order mark (BOM) is written.

If the underlying writer returns an error of kind ErrorKind::Interrupted, this JSON writer will keep retrying to write the data.

Implementations

impl<W> JsonStreamWriter<W>

where W: Write,

pub fn new(writer: W) -> JsonStreamWriter<W>

Creates a JSON writer with default settings

pub fn new_custom( writer: W, writer_settings: WriterSettings, ) -> JsonStreamWriter<W>

Creates a JSON writer with custom settings

The settings can be used to customize how the JSON output will look like.

Trait Implementations

impl<W> Debug for JsonStreamWriter<W>

where W: Write + Debug,

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

Formats the value using the given formatter.

impl<W> JsonWriter for JsonStreamWriter<W>

where W: Write,

type WriterResult = W

Result returned by finish_document

This JSON writer implementation returns the underlying Write to allow for example to reuse it for other purposes. However, the JSON document is already written during JSON writer usage, so the returned Write can be ignored in case it is not needed for anything else.

fn begin_object(&mut self) -> Result<(), Error>

Begins writing a JSON object

fn name(&mut self, name: &str) -> Result<(), Error>

Writes the name of the next JSON object member

fn end_object(&mut self) -> Result<(), Error>

Writes the closing bracket } of the current JSON object

fn begin_array(&mut self) -> Result<(), Error>

Begins writing a JSON array

fn end_array(&mut self) -> Result<(), Error>

Writes the closing bracket ] of the current JSON object

fn string_value(&mut self, value: &str) -> Result<(), Error>

Writes a JSON string value

fn bool_value(&mut self, value: bool) -> Result<(), Error>

Writes a JSON boolean value

fn null_value(&mut self) -> Result<(), Error>

Writes a JSON null value

fn number_value<N>(&mut self, value: N) -> Result<(), Error>

where N: FiniteNumber,

Writes a finite JSON number value

fn fp_number_value<N>(&mut self, value: N) -> Result<(), JsonNumberError>

where N: FloatingPointNumber,

Writes a floating point JSON number value

fn number_value_from_string( &mut self, value: &str, ) -> Result<(), JsonNumberError>

Writes the string representation of a JSON number value

fn finish_document( self, ) -> Result<<JsonStreamWriter<W> as JsonWriter>::WriterResult, Error>

Verifies that the JSON document is complete and flushes the buffer

fn string_value_writer(&mut self) -> Result<impl StringValueWriter, Error>

Provides a writer for lazily writing a JSON string value