Struct CanonicalFormatter

pub struct CanonicalFormatter { /* private fields */ }

A Formatter that produces canonical JSON.

See the crate-level documentation for more detail.

Implementations

impl CanonicalFormatter

pub fn new() -> Self

Create a new CanonicalFormatter object.

Trait Implementations

impl Debug for CanonicalFormatter

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

Formats the value using the given formatter.

impl Default for CanonicalFormatter

fn default() -> CanonicalFormatter

Returns the “default value” for a type.

impl Formatter for CanonicalFormatter

fn write_null<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Writes a null value to the specified writer.

fn write_bool<W: Write + ?Sized>( &mut self, writer: &mut W, arg: bool, ) -> Result<()>

Writes a true or false value to the specified writer.

fn write_i8<W: Write + ?Sized>(&mut self, writer: &mut W, arg: i8) -> Result<()>

Writes an integer value like -123 to the specified writer.

fn write_i16<W: Write + ?Sized>( &mut self, writer: &mut W, arg: i16, ) -> Result<()>

Writes an integer value like -123 to the specified writer.

fn write_i32<W: Write + ?Sized>( &mut self, writer: &mut W, arg: i32, ) -> Result<()>

Writes an integer value like -123 to the specified writer.

fn write_i64<W: Write + ?Sized>( &mut self, writer: &mut W, arg: i64, ) -> Result<()>

Writes an integer value like -123 to the specified writer.

fn write_i128<W: Write + ?Sized>( &mut self, writer: &mut W, arg: i128, ) -> Result<()>

Writes an integer value like -123 to the specified writer.

fn write_u8<W: Write + ?Sized>(&mut self, writer: &mut W, arg: u8) -> Result<()>

Writes an integer value like 123 to the specified writer.

fn write_u16<W: Write + ?Sized>( &mut self, writer: &mut W, arg: u16, ) -> Result<()>

Writes an integer value like 123 to the specified writer.

fn write_u32<W: Write + ?Sized>( &mut self, writer: &mut W, arg: u32, ) -> Result<()>

Writes an integer value like 123 to the specified writer.

fn write_u64<W: Write + ?Sized>( &mut self, writer: &mut W, arg: u64, ) -> Result<()>

Writes an integer value like 123 to the specified writer.

fn write_u128<W: Write + ?Sized>( &mut self, writer: &mut W, arg: u128, ) -> Result<()>

Writes an integer value like 123 to the specified writer.

fn write_f32<W: Write + ?Sized>( &mut self, _writer: &mut W, _value: f32, ) -> Result<()>

Writes a floating point value like -31.26e+12 to the specified writer.

fn write_f64<W: Write + ?Sized>( &mut self, _writer: &mut W, _value: f64, ) -> Result<()>

Writes a floating point value like -31.26e+12 to the specified writer.

fn write_number_str<W: Write + ?Sized>( &mut self, writer: &mut W, value: &str, ) -> Result<()>

Writes a number that has already been rendered to a string.

fn begin_string<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called before each series of write_string_fragment and write_char_escape. Writes a " to the specified writer.

fn end_string<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called after each series of write_string_fragment and write_char_escape. Writes a " to the specified writer.

fn write_string_fragment<W: Write + ?Sized>( &mut self, writer: &mut W, fragment: &str, ) -> Result<()>

Writes a string fragment that doesn’t need any escaping to the specified writer.

fn write_char_escape<W: Write + ?Sized>( &mut self, writer: &mut W, char_escape: CharEscape, ) -> Result<()>

Writes a character escape code to the specified writer.

fn begin_array<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called before every array. Writes a [ to the specified writer.

fn end_array<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called after every array. Writes a ] to the specified writer.

fn begin_array_value<W: Write + ?Sized>( &mut self, writer: &mut W, arg: bool, ) -> Result<()>

Called before every array value. Writes a , if needed to the specified writer.

fn end_array_value<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called after every array value.

fn begin_object<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called before every object. Writes a { to the specified writer.

fn end_object<W: Write + ?Sized>(&mut self, writer: &mut W) -> Result<()>

Called after every object. Writes a } to the specified writer.

fn begin_object_key<W: Write + ?Sized>( &mut self, _writer: &mut W, _first: bool, ) -> Result<()>

Called before every object key.

fn end_object_key<W: Write + ?Sized>(&mut self, _writer: &mut W) -> Result<()>

Called after every object key. A : should be written to the specified writer by either this method or begin_object_value.

fn begin_object_value<W: Write + ?Sized>( &mut self, _writer: &mut W, ) -> Result<()>

Called before every object value. A : should be written to the specified writer by either this method or end_object_key.

fn end_object_value<W: Write + ?Sized>(&mut self, _writer: &mut W) -> Result<()>

Called after every object value.

fn write_raw_fragment<W: Write + ?Sized>( &mut self, writer: &mut W, fragment: &str, ) -> Result<()>

Writes a raw JSON fragment that doesn’t need any escaping to the specified writer.

fn write_byte_array<W>( &mut self, writer: &mut W, value: &[u8], ) -> Result<(), Error>

where W: Write + ?Sized,

Writes the representation of a byte array. Formatters can choose whether to represent bytes as a JSON array of integers (the default), or some JSON string encoding like hex or base64.