Struct serde_cbor::ser::Serializer [−][src]
pub struct Serializer<W> { /* fields omitted */ }
Expand description
A structure for serializing Rust values to CBOR.
Implementations
Creates a new CBOR serializer.
to_vec
and to_writer
should normally be used instead of this method.
Choose concise/packed format for serializer.
In the packed format enum variant names and field names are replaced with numeric indizes to conserve space.
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}]
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.
Unwrap the Writer
from the Serializer
.
Trait Implementations
Serialize a tuple element.
Serialize a tuple struct field.
Serialize a tuple variant field.
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. Read more
type SerializeSeq = CollectionSerializer<'a, W>
type SerializeSeq = CollectionSerializer<'a, W>
Type returned from serialize_seq
for serializing the content of the
sequence. Read more
type SerializeTuple = &'a mut Serializer<W>
type SerializeTuple = &'a mut Serializer<W>
Type returned from serialize_tuple
for serializing the content of
the tuple. Read more
type SerializeTupleStruct = &'a mut Serializer<W>
type SerializeTupleStruct = &'a mut Serializer<W>
Type returned from serialize_tuple_struct
for serializing the
content of the tuple struct. Read more
type SerializeTupleVariant = &'a mut Serializer<W>
type SerializeTupleVariant = &'a mut Serializer<W>
Type returned from serialize_tuple_variant
for serializing the
content of the tuple variant. Read more
type SerializeMap = CollectionSerializer<'a, W>
type SerializeMap = CollectionSerializer<'a, W>
Type returned from serialize_map
for serializing the content of the
map. Read more
type SerializeStruct = StructSerializer<'a, W>
type SerializeStruct = StructSerializer<'a, W>
Type returned from serialize_struct
for serializing the content of
the struct. Read more
type SerializeStructVariant = StructSerializer<'a, W>
type SerializeStructVariant = StructSerializer<'a, W>
Type returned from serialize_struct_variant
for serializing the
content of the struct variant. Read more
Serialize a chunk of raw byte data. Read more
Serialize a ()
value. Read more
Serialize a unit struct like struct Unit
or PhantomData<T>
. Read more
Serialize a unit variant like E::A
in enum E { A, B }
. Read more
Serialize a newtype struct like struct Millimeters(u8)
. Read more
Serialize a newtype variant like E::N
in enum E { N(u8) }
. Read more
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
. Read more
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
. Read more
fn serialize_tuple_struct(
self,
_name: &'static str,
len: usize
) -> Result<&'a mut Serializer<W>>
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
. Read more
fn serialize_tuple_variant(
self,
name: &'static str,
variant_index: u32,
variant: &'static str,
len: usize
) -> Result<&'a mut Serializer<W>>
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
. Read more
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
. Read more
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
. Read more
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
. Read more
Determine whether Serialize
implementations should serialize in
human-readable form. Read more
fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
I: IntoIterator,
<I as IntoIterator>::Item: Serialize,
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. Read more
fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
V: Serialize,
K: Serialize,
I: IntoIterator<Item = (K, V)>,
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. Read more