Struct Serializer

pub struct Serializer<W> { /* private fields */ }

A structure for serializing Rust values to CBOR.

Implementations

impl<W> Serializer<W>

where W: Write,

pub fn new(writer: W) -> Self

Creates a new CBOR serializer.

to_vec and to_writer should normally be used instead of this method.

pub fn packed_format(self) -> Self

Choose concise/packed format for serializer.

In the packed format enum variant names and field names are replaced with numeric indizes to conserve space.

pub fn legacy_enums(self) -> Self

Enable old enum format used by serde_cbor versions <= v0.9.

The legacy_enums option determines how enums are encoded.

This makes no difference when encoding and decoding enums using this crate, but it shows up when decoding to a Value or decoding in other languages.

Examples

Given the following enum

enum Enum {
    Unit,
    NewType(i32),
    Tuple(String, bool),
    Struct{ x: i32, y: i32 },
}

we will give the Value with the same encoding for each case using JSON notation.

Default encodings

• Enum::Unit encodes as "Unit"
• Enum::NewType(10) encodes as {"NewType": 10}
• Enum::Tuple("x", true) encodes as {"Tuple": ["x", true]}

Legacy encodings

• Enum::Unit encodes as "Unit"
• Enum::NewType(10) encodes as ["NewType", 10]
• Enum::Tuple("x", true) encodes as ["Tuple", "x", true]
• Enum::Struct{ x: 5, y: -5 } encodes as ["Struct", {"x": 5, "y": -5}]

pub fn self_describe(&mut self) -> Result<()>

Writes a CBOR self-describe tag to the stream.

Tagging allows a decoder to distinguish different file formats based on their content without further information.

pub fn into_inner(self) -> W

Unwrap the Writer from the Serializer.

Trait Implementations

impl<W: Debug> Debug for Serializer<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, W> SerializeTuple for &'a mut Serializer<W>

where W: Write,

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple element.

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

Finish serializing a tuple.

impl<'a, W> SerializeTupleStruct for &'a mut Serializer<W>

where W: Write,

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple struct field.

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

Finish serializing a tuple struct.

impl<'a, W> SerializeTupleVariant for &'a mut Serializer<W>

where W: Write,

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>(&mut self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a tuple variant field.

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

Finish serializing a tuple variant.

impl<'a, W> Serializer for &'a mut Serializer<W>

where W: Write,

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 = CollectionSerializer<'a, W>

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

type SerializeTuple = &'a mut Serializer<W>

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

type SerializeTupleStruct = &'a mut Serializer<W>

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

type SerializeTupleVariant = &'a mut Serializer<W>

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

type SerializeMap = CollectionSerializer<'a, W>

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

type SerializeStruct = StructSerializer<'a, W>

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

type SerializeStructVariant = StructSerializer<'a, W>

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

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

Serialize a bool value.

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

Serialize an i8 value.

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

Serialize an i16 value.

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

Serialize an i32 value.

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

Serialize an i64 value.

fn serialize_i128(self, value: i128) -> Result<()>

Serialize an i128 value.

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

Serialize a u8 value.

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

Serialize a u16 value.

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

Serialize a u32 value.

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

Serialize a u64 value.

fn serialize_u128(self, value: u128) -> Result<()>

Serialize a u128 value.

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

Serialize an f32 value.

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

Serialize an f64 value.

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

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

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

Serialize a () value.

fn serialize_some<T>(self, value: &T) -> Result<()>

where T: ?Sized + Serialize,

Serialize a Some(T) value.

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

Serialize a None 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>( self, name: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T>( self, name: &'static str, variant_index: u32, variant: &'static str, value: &T, ) -> Result<()>

where T: ?Sized + Serialize,

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

fn serialize_seq( self, len: Option<usize>, ) -> Result<CollectionSerializer<'a, W>>

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<&'a mut Serializer<W>>

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<&'a mut Serializer<W>>

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<&'a mut Serializer<W>>

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<CollectionSerializer<'a, W>>

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<StructSerializer<'a, W>>

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<StructSerializer<'a, W>>

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 is_human_readable(&self) -> bool

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

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.

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map.

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>

where T: Display + ?Sized,

Serialize a string produced by an implementation of Display.