Trait SerializeStruct

trait SerializeStruct

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

Example implementation

The example data format presented on the website demonstrates an implementation of SerializeStruct 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_field<T>(self: &mut Self, key: &'static str, value: &T) -> Result<(), <Self as >::Error>
where
    T: ?Sized + Serialize

Serialize a struct field.

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

Finish serializing a struct.

Provided Methods

fn skip_field(self: &mut Self, key: &'static str) -> Result<(), <Self as >::Error>

Indicate that a struct field has been skipped.

The default implementation does nothing.

Implementors