# Struct serde_json::ser::PrettyFormatter

source · [−]

    pub struct PrettyFormatter<'a> { /* private fields */ }

Expand description

This structure pretty prints a JSON value to make it human readable.

## Implementations

source

### impl<'a> PrettyFormatter<'a>

source

#### pub fn new() -> Self

Construct a pretty printer formatter that defaults to using two spaces for indentation.

source

#### pub fn with_indent(indent: &'a [u8]) -> Self

Construct a pretty printer formatter that uses the `indent` string for indentation.

## Trait Implementations

source

### impl<'a> Clone for PrettyFormatter<'a>

source

#### fn clone(&self) -> PrettyFormatter<'a>

Returns a copy of the value. Read more

1.0.0 · source

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more

source

### impl<'a> Debug for PrettyFormatter<'a>

source

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

Formats the value using the given formatter. Read more

source

### impl<'a> Default for PrettyFormatter<'a>

source

#### fn default() -> Self

Returns the “default value” for a type. Read more

source

### impl<'a> Formatter for PrettyFormatter<'a>

source

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

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

source

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

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

source

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

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

source

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

Called after every array value.

source

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

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

source

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

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

source

#### fn begin_object_key<W>(&mut self, writer: &mut W, first: bool) -> Result<()> where
W: ?Sized + Write,

Called before every object key.

source

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

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

source

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

Called after every object value.

source

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

Writes a `null` value to the specified writer.

source

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

Writes a `true` or `false` value to the specified writer.

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

#### fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<()> where
W: ?Sized + Write,

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

source

#### fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<()> where
W: ?Sized + Write,

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

Writes a character escape code to the specified writer.

source

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

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

source

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

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

## Auto Trait Implementations

### impl<'a> RefUnwindSafe for PrettyFormatter<'a>

### impl<'a> Send for PrettyFormatter<'a>

### impl<'a> Sync for PrettyFormatter<'a>

### impl<'a> Unpin for PrettyFormatter<'a>

### impl<'a> UnwindSafe for PrettyFormatter<'a>

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.