Required Methods

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

Serialize a bool value.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for bool {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_bool(*self)
    }
}

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

Serialize an i8 value.

If the format does not differentiate between i8 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for i8 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_i8(*self)
    }
}

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

Serialize an i16 value.

If the format does not differentiate between i16 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for i16 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_i16(*self)
    }
}

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

Serialize an i32 value.

If the format does not differentiate between i32 and i64, a reasonable implementation would be to cast the value to i64 and forward to serialize_i64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for i32 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_i32(*self)
    }
}

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

Serialize an i64 value.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for i64 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_i64(*self)
    }
}

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

Serialize a u8 value.

If the format does not differentiate between u8 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for u8 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_u8(*self)
    }
}

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

Serialize a u16 value.

If the format does not differentiate between u16 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for u16 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_u16(*self)
    }
}

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

Serialize a u32 value.

If the format does not differentiate between u32 and u64, a reasonable implementation would be to cast the value to u64 and forward to serialize_u64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for u32 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_u32(*self)
    }
}

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

Serialize a u64 value.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for u64 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_u64(*self)
    }
}

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

Serialize an f32 value.

If the format does not differentiate between f32 and f64, a reasonable implementation would be to cast the value to f64 and forward to serialize_f64.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for f32 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_f32(*self)
    }
}

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

Serialize an f64 value.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for f64 {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_f64(*self)
    }
}

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

Serialize a character.

If the format does not support characters, it is reasonable to serialize it as a single element str or a u32.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for char {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_char(*self)
    }
}

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

Serialize a &str.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for str {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self)
    }
}

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

Serialize a chunk of raw byte data.

Enables serializers to serialize byte slices more compactly or more efficiently than other types of slices. If no efficient implementation is available, a reasonable implementation would be to forward to serialize_seq. If forwarded, the implementation looks usually just like this:

# use serde::ser::{Serializer, SerializeSeq};
# use serde_core::__private::doc::Error;
#
# struct MySerializer;
#
# impl Serializer for MySerializer {
#     type Ok = ();
#     type Error = Error;
#
fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error> {
    let mut seq = self.serialize_seq(Some(v.len()))?;
    for b in v {
        seq.serialize_element(b)?;
    }
    seq.end()
}
#
#     serde_core::__serialize_unimplemented! {
#         bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str none some
#         unit unit_struct unit_variant newtype_struct newtype_variant
#         seq tuple tuple_struct tuple_variant map struct struct_variant
#     }
# }

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

Serialize a None value.

# use serde::{Serialize, Serializer};
#
# enum Option<T> {
#     Some(T),
#     None,
# }
#
# use self::Option::{Some, None};
#
impl<T> Serialize for Option<T>
where
    T: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            Some(ref value) => serializer.serialize_some(value),
            None => serializer.serialize_none(),
        }
    }
}
#
# fn main() {}

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

Serialize a Some(T) value.

# use serde::{Serialize, Serializer};
#
# enum Option<T> {
#     Some(T),
#     None,
# }
#
# use self::Option::{Some, None};
#
impl<T> Serialize for Option<T>
where
    T: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            Some(ref value) => serializer.serialize_some(value),
            None => serializer.serialize_none(),
        }
    }
}
#
# fn main() {}

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

Serialize a () value.

# use serde::Serializer;
#
# serde_core::__private_serialize!();
#
impl Serialize for () {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_unit()
    }
}

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

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

A reasonable implementation would be to forward to serialize_unit.

use serde::{Serialize, Serializer};

struct Nothing;

impl Serialize for Nothing {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_unit_struct("Nothing")
    }
}

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

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

The name is the name of the enum, the variant_index is the index of this variant within the enum, and the variant is the name of the variant.

use serde::{Serialize, Serializer};

enum E {
    A,
    B,
}

impl Serialize for E {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            E::A => serializer.serialize_unit_variant("E", 0, "A"),
            E::B => serializer.serialize_unit_variant("E", 1, "B"),
        }
    }
}

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

Serialize a newtype struct like struct Millimeters(u8).

Serializers are encouraged to treat newtype structs as insignificant wrappers around the data they contain. A reasonable implementation would be to forward to value.serialize(self).

use serde::{Serialize, Serializer};

struct Millimeters(u8);

impl Serialize for Millimeters {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_newtype_struct("Millimeters", &self.0)
    }
}

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

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

The name is the name of the enum, the variant_index is the index of this variant within the enum, and the variant is the name of the variant. The value is the data contained within this newtype variant.

use serde::{Serialize, Serializer};

enum E {
    M(String),
    N(u8),
}

impl Serialize for E {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            E::M(ref s) => serializer.serialize_newtype_variant("E", 0, "M", s),
            E::N(n) => serializer.serialize_newtype_variant("E", 1, "N", &n),
        }
    }
}

fn serialize_seq(self: Self, len: Option<usize>) -> Result<<Self as >::SerializeSeq, <Self as >::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.

The argument is the number of elements in the sequence, which may or may not be computable before the sequence is iterated. Some serializers only support sequences whose length is known up front.

# use std::marker::PhantomData;
#
# struct Vec<T>(PhantomData<T>);
#
# impl<T> Vec<T> {
#     fn len(&self) -> usize {
#         unimplemented!()
#     }
# }
#
# impl<'a, T> IntoIterator for &'a Vec<T> {
#     type Item = &'a T;
#     type IntoIter = Box<dyn Iterator<Item = &'a T>>;
#
#     fn into_iter(self) -> Self::IntoIter {
#         unimplemented!()
#     }
# }
#
use serde::ser::{Serialize, SerializeSeq, Serializer};

impl<T> Serialize for Vec<T>
where
    T: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut seq = serializer.serialize_seq(Some(self.len()))?;
        for element in self {
            seq.serialize_element(element)?;
        }
        seq.end()
    }
}

fn serialize_tuple(self: Self, len: usize) -> Result<<Self as >::SerializeTuple, <Self as >::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.

use serde::ser::{Serialize, SerializeTuple, Serializer};

# mod fool {
#     trait Serialize {}
impl<A, B, C> Serialize for (A, B, C)
#     {}
# }
#
# struct Tuple3<A, B, C>(A, B, C);
#
# impl<A, B, C> Serialize for Tuple3<A, B, C>
where
    A: Serialize,
    B: Serialize,
    C: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut tup = serializer.serialize_tuple(3)?;
        tup.serialize_element(&self.0)?;
        tup.serialize_element(&self.1)?;
        tup.serialize_element(&self.2)?;
        tup.end()
    }
}

use serde::ser::{Serialize, SerializeTuple, Serializer};

const VRAM_SIZE: usize = 386;
struct Vram([u16; VRAM_SIZE]);

impl Serialize for Vram {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut seq = serializer.serialize_tuple(VRAM_SIZE)?;
        for element in &self.0[..] {
            seq.serialize_element(element)?;
        }
        seq.end()
    }
}

fn serialize_tuple_struct(self: Self, name: &'static str, len: usize) -> Result<<Self as >::SerializeTupleStruct, <Self as >::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.

The name is the name of the tuple struct and the len is the number of data fields that will be serialized.

use serde::ser::{Serialize, SerializeTupleStruct, Serializer};

struct Rgb(u8, u8, u8);

impl Serialize for Rgb {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut ts = serializer.serialize_tuple_struct("Rgb", 3)?;
        ts.serialize_field(&self.0)?;
        ts.serialize_field(&self.1)?;
        ts.serialize_field(&self.2)?;
        ts.end()
    }
}

fn serialize_tuple_variant(self: Self, name: &'static str, variant_index: u32, variant: &'static str, len: usize) -> Result<<Self as >::SerializeTupleVariant, <Self as >::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.

The name is the name of the enum, the variant_index is the index of this variant within the enum, the variant is the name of the variant, and the len is the number of data fields that will be serialized.

use serde::ser::{Serialize, SerializeTupleVariant, Serializer};

enum E {
    T(u8, u8),
    U(String, u32, u32),
}

impl Serialize for E {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            E::T(ref a, ref b) => {
                let mut tv = serializer.serialize_tuple_variant("E", 0, "T", 2)?;
                tv.serialize_field(a)?;
                tv.serialize_field(b)?;
                tv.end()
            }
            E::U(ref a, ref b, ref c) => {
                let mut tv = serializer.serialize_tuple_variant("E", 1, "U", 3)?;
                tv.serialize_field(a)?;
                tv.serialize_field(b)?;
                tv.serialize_field(c)?;
                tv.end()
            }
        }
    }
}

fn serialize_map(self: Self, len: Option<usize>) -> Result<<Self as >::SerializeMap, <Self as >::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.

The argument is the number of elements in the map, which may or may not be computable before the map is iterated. Some serializers only support maps whose length is known up front.

# use std::marker::PhantomData;
#
# struct HashMap<K, V>(PhantomData<K>, PhantomData<V>);
#
# impl<K, V> HashMap<K, V> {
#     fn len(&self) -> usize {
#         unimplemented!()
#     }
# }
#
# impl<'a, K, V> IntoIterator for &'a HashMap<K, V> {
#     type Item = (&'a K, &'a V);
#     type IntoIter = Box<dyn Iterator<Item = (&'a K, &'a V)>>;
#
#     fn into_iter(self) -> Self::IntoIter {
#         unimplemented!()
#     }
# }
#
use serde::ser::{Serialize, SerializeMap, Serializer};

impl<K, V> Serialize for HashMap<K, V>
where
    K: Serialize,
    V: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut map = serializer.serialize_map(Some(self.len()))?;
        for (k, v) in self {
            map.serialize_entry(k, v)?;
        }
        map.end()
    }
}

fn serialize_struct(self: Self, name: &'static str, len: usize) -> Result<<Self as >::SerializeStruct, <Self as >::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.

The name is the name of the struct and the len is the number of data fields that will be serialized. len does not include fields which are skipped with SerializeStruct::skip_field.

use serde::ser::{Serialize, SerializeStruct, Serializer};

struct Rgb {
    r: u8,
    g: u8,
    b: u8,
}

impl Serialize for Rgb {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut rgb = serializer.serialize_struct("Rgb", 3)?;
        rgb.serialize_field("r", &self.r)?;
        rgb.serialize_field("g", &self.g)?;
        rgb.serialize_field("b", &self.b)?;
        rgb.end()
    }
}

fn serialize_struct_variant(self: Self, name: &'static str, variant_index: u32, variant: &'static str, len: usize) -> Result<<Self as >::SerializeStructVariant, <Self as >::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.

The name is the name of the enum, the variant_index is the index of this variant within the enum, the variant is the name of the variant, and the len is the number of data fields that will be serialized. len does not include fields which are skipped with SerializeStructVariant::skip_field.

use serde::ser::{Serialize, SerializeStructVariant, Serializer};

enum E {
    S { r: u8, g: u8, b: u8 },
}

impl Serialize for E {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match *self {
            E::S {
                ref r,
                ref g,
                ref b,
            } => {
                let mut sv = serializer.serialize_struct_variant("E", 0, "S", 3)?;
                sv.serialize_field("r", r)?;
                sv.serialize_field("g", g)?;
                sv.serialize_field("b", b)?;
                sv.end()
            }
        }
    }
}