Struct postcard::Serializer

pub struct Serializer<F> where
    F: SerFlavor,  {
    pub output: F,
}

A serde compatible serializer, generic over "Flavors" of serializing plugins.

It should rarely be necessary to directly use this type unless you are implementing your own SerFlavor.

See the docs for SerFlavor for more information about "flavors" of serialization

Fields

output: F

This is the Flavor(s) that will be used to modify or store any bytes generated by serialization

Trait Implementations

impl<'a, F> SerializeMap for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_key<T: ?Sized>(&mut self, key: &T) -> Result<()> where
    T: Serialize, 

Serialize a map key.

fn serialize_value<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize, 

Serialize a map value.

fn end(self) -> Result<()>

Finish serializing a map.

pub fn serialize_entry<K, V>(
    &mut self,
    key: &K,
    value: &V
) -> Result<(), Self::Error> where
    V: Serialize + ?Sized,
    K: Serialize + ?Sized, 

Serialize a map entry consisting of a key and a value.

impl<'a, F> SerializeSeq for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

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

Serialize a sequence element.

fn end(self) -> Result<()>

Finish serializing a sequence.

impl<'a, F> SerializeStruct for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(
    &mut self,
    _key: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize, 

Serialize a struct field.

fn end(self) -> Result<()>

Finish serializing a struct.

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

Indicate that a struct field has been skipped.

impl<'a, F> SerializeStructVariant for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(
    &mut self,
    _key: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize, 

Serialize a struct variant field.

fn end(self) -> Result<()>

Finish serializing a struct variant.

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

Indicate that a struct variant field has been skipped.

impl<'a, F> SerializeTuple for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

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

Serialize a tuple element.

fn end(self) -> Result<()>

Finish serializing a tuple.

impl<'a, F> SerializeTupleStruct for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize, 

Serialize a tuple struct field.

fn end(self) -> Result<()>

Finish serializing a tuple struct.

impl<'a, F> SerializeTupleVariant for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

Must match the Ok type of our Serializer.

type Error = Error

Must match the Error type of our Serializer.

fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()> where
    T: Serialize, 

Serialize a tuple variant field.

fn end(self) -> Result<()>

Finish serializing a tuple variant.

impl<'a, F> Serializer for &'a mut Serializer<F> where
    F: SerFlavor, 

type Ok = ()

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an io::Write or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around.

type Error = Error

The error type when some error occurs during serialization.

type SerializeSeq = Self

Type returned from serialize_seq for serializing the content of the sequence.

type SerializeTuple = Self

Type returned from serialize_tuple for serializing the content of the tuple.

type SerializeTupleStruct = Self

Type returned from serialize_tuple_struct for serializing the content of the tuple struct.

type SerializeTupleVariant = Self

Type returned from serialize_tuple_variant for serializing the content of the tuple variant.

type SerializeMap = Self

Type returned from serialize_map for serializing the content of the map.

type SerializeStruct = Self

Type returned from serialize_struct for serializing the content of the struct.

type SerializeStructVariant = Self

Type returned from serialize_struct_variant for serializing the content of the struct variant.

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form.

fn serialize_bool(self, v: bool) -> Result<()>

Serialize a bool value.

fn serialize_i8(self, v: i8) -> Result<()>

Serialize an i8 value.

fn serialize_i16(self, v: i16) -> Result<()>

Serialize an i16 value.

fn serialize_i32(self, v: i32) -> Result<()>

Serialize an i32 value.

fn serialize_i64(self, v: i64) -> Result<()>

Serialize an i64 value.

fn serialize_u8(self, v: u8) -> Result<()>

Serialize a u8 value.

fn serialize_u16(self, v: u16) -> Result<()>

Serialize a u16 value.

fn serialize_u32(self, v: u32) -> Result<()>

Serialize a u32 value.

fn serialize_u64(self, v: u64) -> Result<()>

Serialize a u64 value.

fn serialize_f32(self, v: f32) -> Result<()>

Serialize an f32 value.

fn serialize_f64(self, v: f64) -> Result<()>

Serialize an f64 value.

fn serialize_char(self, v: char) -> Result<()>

Serialize a character.

fn serialize_str(self, v: &str) -> Result<()>

Serialize a &str.

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

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<()>

Serialize a None value.

fn serialize_some<T: ?Sized>(self, value: &T) -> Result<()> where
    T: Serialize, 

Serialize a Some(T) value.

fn serialize_unit(self) -> Result<()>

Serialize a () value.

fn serialize_unit_struct(self, _name: &'static str) -> Result<()>

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

fn serialize_unit_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str
) -> Result<()>

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

fn serialize_newtype_struct<T: ?Sized>(
    self,
    _name: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize, 

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T: ?Sized>(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    value: &T
) -> Result<()> where
    T: Serialize, 

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

fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq>

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.

fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple>

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.

fn serialize_tuple_struct(
    self,
    _name: &'static str,
    _len: usize
) -> Result<Self::SerializeTupleStruct>

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.

fn serialize_tuple_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    _len: usize
) -> Result<Self::SerializeTupleVariant>

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.

fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap>

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.

fn serialize_struct(
    self,
    _name: &'static str,
    _len: usize
) -> Result<Self::SerializeStruct>

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.

fn serialize_struct_variant(
    self,
    _name: &'static str,
    variant_index: u32,
    _variant: &'static str,
    _len: usize
) -> Result<Self::SerializeStructVariant>

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.

fn collect_str<T: ?Sized>(self, _value: &T) -> Result<Self::Ok> where
    T: Display, 

Serialize a string produced by an implementation of Display.

pub fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>

Serialize an i128 value.

pub fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error>

Serialize a u128 value.

pub fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Serialize, 

Collect an iterator as a sequence.

pub fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
    V: Serialize,
    K: Serialize,
    I: IntoIterator<Item = (K, V)>, 

Collect an iterator as a map.