Struct PrettyCompactFormatter

pub struct PrettyCompactFormatter { /* private fields */ }

The formatter.

The PrettyCompactFormatter type implements a pretty serde_json formatter which tries to be as compact as possible. This can increase the readability of formatted JSON.

Basic usage

• Use PrettyCompactFormatter::new() to create a formatter with a set of default rules.

  Defaults are:

  • indentation: 2 characters
  • maximum line length: 120 characters

• Use PrettyCompactFormatter::no_rules() without any rules.

  Without any further applied configuration it acts as a plain pretty formatter.

Configuration

• Change the indentation with PrettyCompactFormatter::with_indent.

use json_pretty_compact::PrettyCompactFormatter;

let formatter = PrettyCompactFormatter::new().with_indent(4);

• Change the maximum line length length with PrettyCompactFormatter::with_max_line_length.

use json_pretty_compact::PrettyCompactFormatter;

let formatter = PrettyCompactFormatter::new().with_max_line_length(80);

Implementations

impl PrettyCompactFormatter

pub fn new() -> PrettyCompactFormatter

Creates a PrettyCompactFormatter with a set of default rules.

pub fn no_rules() -> PrettyCompactFormatter

Creates a PrettyCompactFormatter without any rules applied.

pub fn with_indent(self, indent: u32) -> Self

Changes the indentation to the given value.

pub fn with_max_line_length(self, len: u32) -> Self

Changes the maximum line length to the given value.

Trait Implementations

impl Default for PrettyCompactFormatter

fn default() -> Self

Returns the “default value” for a type.

impl Formatter for PrettyCompactFormatter

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

Writes a null value to the specified writer.

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

Writes a true or false value to the specified writer.

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

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

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

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

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

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

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

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

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

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

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

Writes an integer value like 123 to the specified writer.

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

Writes an integer value like 123 to the specified writer.

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

Writes an integer value like 123 to the specified writer.

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

Writes an integer value like 123 to the specified writer.

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

Writes an integer value like 123 to the specified writer.

fn write_f32<W: ?Sized + Write>( &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: ?Sized + Write>( &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: ?Sized + Write>( &mut self, writer: &mut W, value: &str, ) -> Result<()>

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

fn begin_string<W: ?Sized + Write>(&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: ?Sized + Write>(&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: ?Sized + Write>( &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: ?Sized + Write>( &mut self, _writer: &mut W, char_escape: CharEscape, ) -> Result<()>

Writes a character escape code to the specified writer.

fn write_byte_array<W: ?Sized + Write>( &mut self, writer: &mut W, value: &[u8], ) -> Result<()>

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.

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

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

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

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

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

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

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

Called after every array value.

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

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

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

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

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

Called before every object key.

fn end_object_key<W: ?Sized + Write>(&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: ?Sized + Write>( &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: ?Sized + Write>(&mut self, _writer: &mut W) -> Result<()>

Called after every object value.

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

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