Struct serde_tagged::ser::adj::map::Serializer

pub struct Serializer<'a, S, Tk: ?Sized + 'a, Tv: ?Sized + 'a, Vk: ?Sized + 'a> { /* fields omitted */ }

A serializer that Serializes the specified tag-key, tag, value-key and value as map.

The specified parameters will be serialized as map with two entries, where one entry contains a mapping from the tag-key to the tag and the second entry contains a mapping from the value-key to the value. The specified serializer performs the actual serialization and thus controls the data format. For more information on this tag-format, see the module documentation.

Warning

You should prefer the serialize function over this serializer implementation. To serialize map-entries, the serializer implementation may need to allocate memory on the heap. This can be avoided in the serialize function.

Methods

impl<'a, S, Tk: ?Sized, Tv: ?Sized, Vk: ?Sized> Serializer<'a, S, Tk, Tv, Vk> where
    S: Serializer,
    Tk: Serialize,
    Tv: Serialize,
    Vk: Serialize, 

pub fn new(
    delegate: S,
    tag_key: &'a Tk,
    tag_value: &'a Tv,
    value_key: &'a Vk
) -> Self

Creates a new Serializer with the specified tag-key, tag-value, value-key, and underlying serializer.

Trait Implementations

impl<'a, S, Tk: ?Sized, Tv: ?Sized, Vk: ?Sized> HasDelegate for Serializer<'a, S, Tk, Tv, Vk> where
    S: Serializer,
    Tk: Serialize,
    Tv: Serialize,
    Vk: Serialize, 

type Ok = S::Ok

type Error = S::Error

type Delegate = S

fn delegate(self) -> S

Returns the delegate-serializer of this object.

impl<'a, S, Tk: ?Sized, Tv: ?Sized, Vk: ?Sized> Serializer for Serializer<'a, S, Tk, Tv, Vk> where
    S: Serializer,
    Tk: Serialize,
    Tv: Serialize,
    Vk: Serialize, 

type Ok = S::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.

type Error = S::Error

The error type when some error occurs during serialization.

type SerializeSeq = SerializeSeqAsMapValue<S::SerializeMap>

Type returned from [serialize_seq] for serializing the content of the sequence.

type SerializeTuple = SerializeTupleAsMapValue<S::SerializeMap>

Type returned from [serialize_tuple] for serializing the content of the tuple.

type SerializeTupleStruct = SerializeTupleStructAsMapValue<S::SerializeMap>

Type returned from [serialize_tuple_struct] for serializing the content of the tuple struct.

type SerializeMap = SerializeMapAsMapValue<S::SerializeMap>

Type returned from [serialize_map] for serializing the content of the map.

type SerializeStruct = SerializeStructAsMapValue<S::SerializeMap>

Type returned from [serialize_struct] for serializing the content of the struct.

type SerializeTupleVariant = SerializeTupleVariantAsMapValue<S::SerializeMap>

Type returned from [serialize_tuple_variant] for serializing the content of the tuple variant.

type SerializeStructVariant = SerializeStructVariantAsMapValue<S::SerializeMap>

Type returned from [serialize_struct_variant] for serializing the content of the struct variant.

fn serialize_bool(self, value: bool) -> Result<Self::Ok, Self::Error>

Serialize a bool value.

fn serialize_i8(self, value: i8) -> Result<Self::Ok, Self::Error>

Serialize an i8 value.

fn serialize_i16(self, value: i16) -> Result<Self::Ok, Self::Error>

Serialize an i16 value.

fn serialize_i32(self, value: i32) -> Result<Self::Ok, Self::Error>

Serialize an i32 value.

fn serialize_i64(self, value: i64) -> Result<Self::Ok, Self::Error>

Serialize an i64 value.

fn serialize_u8(self, value: u8) -> Result<Self::Ok, Self::Error>

Serialize a u8 value.

fn serialize_u16(self, value: u16) -> Result<Self::Ok, Self::Error>

Serialize a u16 value.

fn serialize_u32(self, value: u32) -> Result<Self::Ok, Self::Error>

Serialize a u32 value.

fn serialize_u64(self, value: u64) -> Result<Self::Ok, Self::Error>

Serialize a u64 value.

fn serialize_f32(self, value: f32) -> Result<Self::Ok, Self::Error>

Serialize an f32 value.

fn serialize_f64(self, value: f64) -> Result<Self::Ok, Self::Error>

Serialize an f64 value.

fn serialize_char(self, value: char) -> Result<Self::Ok, Self::Error>

Serialize a character.

fn serialize_str(self, value: &str) -> Result<Self::Ok, Self::Error>

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<Self::Ok, Self::Error>

Serialize a [None] value.

fn serialize_some<V: ?Sized>(self, value: &V) -> Result<Self::Ok, Self::Error> where
    V: Serialize, 

Serialize a [Some(T)] value.

fn serialize_unit(self) -> Result<Self::Ok, Self::Error>

Serialize a () value.

fn serialize_unit_struct(
    self,
    name: &'static str
) -> Result<Self::Ok, Self::Error>

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

fn serialize_unit_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str
) -> Result<Self::Ok, Self::Error>

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

fn serialize_newtype_struct<V: ?Sized>(
    self,
    name: &'static str,
    value: &V
) -> Result<Self::Ok, Self::Error> where
    V: Serialize, 

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<V: ?Sized>(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str,
    value: &V
) -> Result<Self::Ok, Self::Error> where
    V: Serialize, 

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

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

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.

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

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.

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

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.

fn serialize_tuple_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str,
    len: usize
) -> Result<Self::SerializeTupleVariant, Self::Error>

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.

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

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.

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

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.

fn serialize_struct_variant(
    self,
    name: &'static str,
    variant_index: u32,
    variant: &'static str,
    len: usize
) -> Result<Self::SerializeStructVariant, Self::Error>

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.

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.

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.

fn collect_str<V: ?Sized>(self, value: &V) -> Result<Self::Ok, Self::Error> where
    V: Display, 

Serialize a string produced by an implementation of Display.

fn is_human_readable(&self) -> bool

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