pub trait Formatter {
Show 31 methods
// Provided methods
fn write_null<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_bool<W>(
&mut self,
writer: &mut W,
value: bool,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_i128<W>(
&mut self,
writer: &mut W,
value: i128,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_u128<W>(
&mut self,
writer: &mut W,
value: u128,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_number_str<W>(
&mut self,
writer: &mut W,
value: &str,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_string_fragment<W>(
&mut self,
writer: &mut W,
fragment: &str,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_char_escape<W>(
&mut self,
writer: &mut W,
char_escape: CharEscape,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_byte_array<W>(
&mut self,
writer: &mut W,
value: &[u8],
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_array_value<W>(
&mut self,
writer: &mut W,
first: bool,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_array_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_object_key<W>(
&mut self,
writer: &mut W,
first: bool,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_object_key<W>(&mut self, _writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn begin_object_value<W>(&mut self, writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn end_object_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
where W: Write + ?Sized { ... }
fn write_raw_fragment<W>(
&mut self,
writer: &mut W,
fragment: &str,
) -> Result<(), Error>
where W: Write + ?Sized { ... }
}Expand description
This trait abstracts away serializing the JSON control characters, which allows the user to optionally pretty print the JSON output.
Provided Methods§
Sourcefn write_null<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn write_null<W>(&mut self, writer: &mut W) -> Result<(), Error>
Writes a null value to the specified writer.
Sourcefn write_bool<W>(&mut self, writer: &mut W, value: bool) -> Result<(), Error>
fn write_bool<W>(&mut self, writer: &mut W, value: bool) -> Result<(), Error>
Writes a true or false value to the specified writer.
Sourcefn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<(), Error>
fn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<(), Error>
Writes an integer value like -123 to the specified writer.
Sourcefn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<(), Error>
fn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<(), Error>
Writes an integer value like -123 to the specified writer.
Sourcefn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<(), Error>
fn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<(), Error>
Writes an integer value like -123 to the specified writer.
Sourcefn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<(), Error>
fn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<(), Error>
Writes an integer value like -123 to the specified writer.
Sourcefn write_i128<W>(&mut self, writer: &mut W, value: i128) -> Result<(), Error>
fn write_i128<W>(&mut self, writer: &mut W, value: i128) -> Result<(), Error>
Writes an integer value like -123 to the specified writer.
Sourcefn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<(), Error>
fn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<(), Error>
Writes an integer value like 123 to the specified writer.
Sourcefn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<(), Error>
fn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<(), Error>
Writes an integer value like 123 to the specified writer.
Sourcefn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<(), Error>
fn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<(), Error>
Writes an integer value like 123 to the specified writer.
Sourcefn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<(), Error>
fn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<(), Error>
Writes an integer value like 123 to the specified writer.
Sourcefn write_u128<W>(&mut self, writer: &mut W, value: u128) -> Result<(), Error>
fn write_u128<W>(&mut self, writer: &mut W, value: u128) -> Result<(), Error>
Writes an integer value like 123 to the specified writer.
Sourcefn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<(), Error>
fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<(), Error>
Writes a floating point value like -31.26e+12 to the specified writer.
§Special cases
This function does not check for NaN or infinity. If the input number is not a finite float, the printed representation will be some correctly formatted but unspecified numerical value.
Please check is_finite yourself before calling this function, or
check is_nan and is_infinite and handle those cases yourself
with a different Formatter method.
Sourcefn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<(), Error>
fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<(), Error>
Writes a floating point value like -31.26e+12 to the specified writer.
§Special cases
This function does not check for NaN or infinity. If the input number is not a finite float, the printed representation will be some correctly formatted but unspecified numerical value.
Please check is_finite yourself before calling this function, or
check is_nan and is_infinite and handle those cases yourself
with a different Formatter method.
Sourcefn write_number_str<W>(
&mut self,
writer: &mut W,
value: &str,
) -> Result<(), Error>
fn write_number_str<W>( &mut self, writer: &mut W, value: &str, ) -> Result<(), Error>
Writes a number that has already been rendered to a string.
Sourcefn begin_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called before each series of write_string_fragment and
write_char_escape. Writes a " to the specified writer.
Sourcefn end_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_string<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called after each series of write_string_fragment and
write_char_escape. Writes a " to the specified writer.
Sourcefn write_string_fragment<W>(
&mut self,
writer: &mut W,
fragment: &str,
) -> Result<(), Error>
fn write_string_fragment<W>( &mut self, writer: &mut W, fragment: &str, ) -> Result<(), Error>
Writes a string fragment that doesn’t need any escaping to the specified writer.
Sourcefn write_char_escape<W>(
&mut self,
writer: &mut W,
char_escape: CharEscape,
) -> Result<(), Error>
fn write_char_escape<W>( &mut self, writer: &mut W, char_escape: CharEscape, ) -> Result<(), Error>
Writes a character escape code to the specified writer.
Sourcefn write_byte_array<W>(
&mut self,
writer: &mut W,
value: &[u8],
) -> Result<(), Error>
fn write_byte_array<W>( &mut self, writer: &mut W, value: &[u8], ) -> Result<(), Error>
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.
Sourcefn begin_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called before every array. Writes a [ to the specified
writer.
Sourcefn end_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_array<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called after every array. Writes a ] to the specified
writer.
Sourcefn begin_array_value<W>(
&mut self,
writer: &mut W,
first: bool,
) -> Result<(), Error>
fn begin_array_value<W>( &mut self, writer: &mut W, first: bool, ) -> Result<(), Error>
Called before every array value. Writes a , if needed to
the specified writer.
Sourcefn end_array_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
fn end_array_value<W>(&mut self, _writer: &mut W) -> Result<(), Error>
Called after every array value.
Sourcefn begin_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called before every object. Writes a { to the specified
writer.
Sourcefn end_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn end_object<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called after every object. Writes a } to the specified
writer.
Sourcefn begin_object_key<W>(
&mut self,
writer: &mut W,
first: bool,
) -> Result<(), Error>
fn begin_object_key<W>( &mut self, writer: &mut W, first: bool, ) -> Result<(), Error>
Called before every object key.
Sourcefn end_object_key<W>(&mut self, _writer: &mut W) -> Result<(), Error>
fn end_object_key<W>(&mut self, _writer: &mut W) -> Result<(), Error>
Called after every object key. A : should be written to the
specified writer by either this method or
begin_object_value.
Sourcefn begin_object_value<W>(&mut self, writer: &mut W) -> Result<(), Error>
fn begin_object_value<W>(&mut self, writer: &mut W) -> Result<(), Error>
Called before every object value. A : should be written to
the specified writer by either this method or
end_object_key.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.