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

    fn serialize_field<T: ?Sized>(
        &mut self,
        key: &'static str,
        value: &T
    ) -> Result<(), Self::Error>
        T: Serialize
; fn end(self) -> Result<Self::Ok, Self::Error>; fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error> { ... } }
Expand description

Returned from Serializer::serialize_struct.

Example use

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>
        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)?;

Example implementation

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

Required Associated Types

Must match the Ok type of our Serializer.

Must match the Error type of our Serializer.

Required Methods

Serialize a struct field.

Finish serializing a struct.

Provided Methods

Indicate that a struct field has been skipped.