Trait SerializeTuple

trait SerializeTuple

Returned from Serializer::serialize_tuple.

Example use

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

# mod fool {
#     trait Serialize {}
impl<T> Serialize for [T; 16]
#     {}
# }
#
# impl<T> Serialize for Array<T>
where
    T: Serialize,
{
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut seq = serializer.serialize_tuple(16)?;
        for element in self {
            seq.serialize_element(element)?;
        }
        seq.end()
    }
}

Example implementation

The example data format presented on the website demonstrates an implementation of SerializeTuple for a basic JSON data format.

Associated Types

type Ok

Must match the Ok type of our Serializer.

type Error: TraitBound { trait_: Path { path: "Error", id: Id(220), args: None }, generic_params: [], modifier: None }

Must match the Error type of our Serializer.

Required Methods

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

Serialize a tuple element.

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

Finish serializing a tuple.

Implementors