Trait SerializeTupleVariant

pub trait SerializeTupleVariant {
    type Ok;
    type Error: Error;

    // Required methods
    fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
       where T: Serialize + ?Sized;
    fn end(self) -> Result<Self::Ok, Self::Error>;
}

Returned from Serializer::serialize_tuple_variant.

Example use

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()
            }
        }
    }
}

Example implementation

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

Required Associated Types

type Ok

Must match the Ok type of our Serializer.

type Error: Error

Must match the Error type of our Serializer.

Required Methods

fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>

where T: Serialize + ?Sized,

Serialize a tuple variant field.

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

Finish serializing a tuple variant.

Object Safety

This trait is not object safe.

Implementors

impl<Ok, Error> SerializeTupleVariant for Impossible<Ok, Error>

where Error: Error,

type Ok = Ok

type Error = Error