# Struct serde_json::ser::Serializer

source · [−]

    pub struct Serializer<W, F = CompactFormatter> { /* private fields */ }

Expand description

A structure for serializing Rust values into JSON.

## Implementations

source

### impl<W> Serializer<W> where
W: Write,

source

#### pub fn new(writer: W) -> Self

Creates a new JSON serializer.

source

### impl<'a, W> Serializer<W, PrettyFormatter<'a>> where
W: Write,

source

#### pub fn pretty(writer: W) -> Self

Creates a new JSON pretty print serializer.

source

### impl<W, F> Serializer<W, F> where
W: Write,
F: Formatter,

source

#### pub fn with_formatter(writer: W, formatter: F) -> Self

Creates a new JSON visitor whose output will be written to the writer specified.

source

#### pub fn into_inner(self) -> W

Unwrap the `Writer` from the `Serializer`.

## Trait Implementations

source

### impl<'a, W, F> Serializer for &'a mut Serializer<W, F> where
W: Write,
F: Formatter,

source

#### fn serialize_newtype_struct<T>(self, _name: &'static str, value: &T) -> Result<()> where
T: ?Sized + Serialize,

Serialize newtypes without an object wrapper.

#### type Ok = ()

The output type produced by this `Serializer` during successful serialization. Most serializers that produce text or binary output should set `Ok = ()` and serialize into an `io::Write` or buffer contained within the `Serializer` instance. Serializers that build in-memory data structures may be simplified by using `Ok` to propagate the data structure around. Read more

#### type Error = Error

The error type when some error occurs during serialization.

#### type SerializeSeq = Compound<'a, W, F>

Type returned from `serialize_seq` for serializing the content of the sequence. Read more

#### type SerializeTuple = Compound<'a, W, F>

Type returned from `serialize_tuple` for serializing the content of the tuple. Read more

#### type SerializeTupleStruct = Compound<'a, W, F>

Type returned from `serialize_tuple_struct` for serializing the content of the tuple struct. Read more

#### type SerializeTupleVariant = Compound<'a, W, F>

Type returned from `serialize_tuple_variant` for serializing the content of the tuple variant. Read more

#### type SerializeMap = Compound<'a, W, F>

Type returned from `serialize_map` for serializing the content of the map. Read more

#### type SerializeStruct = Compound<'a, W, F>

Type returned from `serialize_struct` for serializing the content of the struct. Read more

#### type SerializeStructVariant = Compound<'a, W, F>

Type returned from `serialize_struct_variant` for serializing the content of the struct variant. Read more

source

#### fn serialize_bool(self, value: bool) -> Result<()>

Serialize a `bool` value. Read more

source

#### fn serialize_i8(self, value: i8) -> Result<()>

Serialize an `i8` value. Read more

source

#### fn serialize_i16(self, value: i16) -> Result<()>

Serialize an `i16` value. Read more

source

#### fn serialize_i32(self, value: i32) -> Result<()>

Serialize an `i32` value. Read more

source

#### fn serialize_i64(self, value: i64) -> Result<()>

Serialize an `i64` value. Read more

source

#### fn serialize_i128(self, value: i128) -> Result<()>

Serialize an `i128` value. Read more

source

#### fn serialize_u8(self, value: u8) -> Result<()>

Serialize a `u8` value. Read more

source

#### fn serialize_u16(self, value: u16) -> Result<()>

Serialize a `u16` value. Read more

source

#### fn serialize_u32(self, value: u32) -> Result<()>

Serialize a `u32` value. Read more

source

#### fn serialize_u64(self, value: u64) -> Result<()>

Serialize a `u64` value. Read more

source

#### fn serialize_u128(self, value: u128) -> Result<()>

Serialize a `u128` value. Read more

source

#### fn serialize_f32(self, value: f32) -> Result<()>

Serialize an `f32` value. Read more

source

#### fn serialize_f64(self, value: f64) -> Result<()>

Serialize an `f64` value. Read more

source

#### fn serialize_char(self, value: char) -> Result<()>

Serialize a character. Read more

source

#### fn serialize_str(self, value: &str) -> Result<()>

Serialize a `&str`. Read more

source

#### fn serialize_bytes(self, value: &[u8]) -> Result<()>

Serialize a chunk of raw byte data. Read more

source

#### fn serialize_unit(self) -> Result<()>

Serialize a `()` value. Read more

source

#### fn serialize_unit_struct(self, _name: &'static str) -> Result<()>

Serialize a unit struct like `struct Unit` or `PhantomData<T>`. Read more

source

#### fn serialize_unit_variant(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str
) -> Result<()>

Serialize a unit variant like `E::A` in `enum E { A, B }`. Read more

source

#### fn serialize_newtype_variant<T>(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
value: &T
) -> Result<()> where
T: ?Sized + Serialize,

Serialize a newtype variant like `E::N` in `enum E { N(u8) }`. Read more

source

#### fn serialize_none(self) -> Result<()>

Serialize a `None` value. Read more

source

#### fn serialize_some<T>(self, value: &T) -> Result<()> where
T: ?Sized + Serialize,

Serialize a `Some(T)` value. Read more

source

#### fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq>

Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to `serialize_element`, then a call to `end`. Read more

source

#### fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple>

Begin to serialize a statically sized sequence whose length will be known at deserialization time without looking at the serialized data. This call must be followed by zero or more calls to `serialize_element`, then a call to `end`. Read more

source

#### fn serialize_tuple_struct(
self,
_name: &'static str,
len: usize
) -> Result<Self::SerializeTupleStruct>

Begin to serialize a tuple struct like `struct Rgb(u8, u8, u8)`. This call must be followed by zero or more calls to `serialize_field`, then a call to `end`. Read more

source

#### fn serialize_tuple_variant(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
len: usize
) -> Result<Self::SerializeTupleVariant>

Begin to serialize a tuple variant like `E::T` in `enum E { T(u8, u8) }`. This call must be followed by zero or more calls to `serialize_field`, then a call to `end`. Read more

source

#### fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap>

Begin to serialize a map. This call must be followed by zero or more calls to `serialize_key` and `serialize_value`, then a call to `end`. Read more

source

#### fn serialize_struct(
self,
name: &'static str,
len: usize
) -> Result<Self::SerializeStruct>

Begin to serialize a struct like `struct Rgb { r: u8, g: u8, b: u8 }`. This call must be followed by zero or more calls to `serialize_field`, then a call to `end`. Read more

source

#### fn serialize_struct_variant(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
len: usize
) -> Result<Self::SerializeStructVariant>

Begin to serialize a struct variant like `E::S` in `enum E { S { r: u8, g: u8, b: u8 } }`. This call must be followed by zero or more calls to `serialize_field`, then a call to `end`. Read more

source

#### fn collect_str<T>(self, value: &T) -> Result<()> where
T: ?Sized + Display,

Serialize a string produced by an implementation of `Display`. Read more

source

#### fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
I: IntoIterator,
<I as IntoIterator>::Item: Serialize,

Collect an iterator as a sequence. Read more

source

#### fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
K: Serialize,
V: Serialize,
I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map. Read more

source

#### fn is_human_readable(&self) -> bool

Determine whether `Serialize` implementations should serialize in human-readable form. Read more

## Auto Trait Implementations

### impl<W, F> RefUnwindSafe for Serializer<W, F> where
F: RefUnwindSafe,
W: RefUnwindSafe,

### impl<W, F> Send for Serializer<W, F> where
F: Send,
W: Send,

### impl<W, F> Sync for Serializer<W, F> where
F: Sync,
W: Sync,

### impl<W, F> Unpin for Serializer<W, F> where
F: Unpin,
W: Unpin,

### impl<W, F> UnwindSafe for Serializer<W, F> where
F: UnwindSafe,
W: UnwindSafe,

## 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, 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.