Struct serde_cbor::Serializer
[−]
[src]
pub struct Serializer<W> { /* fields omitted */ }
A structure for serializing Rust values to CBOR.
Methods
impl<W> Serializer<W> where
W: Write,
[src]
W: Write,
pub fn new(writer: W) -> Serializer<W>
[src]
Creates a new CBOR serializer.
pub fn packed(writer: W) -> Serializer<W>
[src]
Creates a new "packed" CBOR serializer.
Struct fields and enum variants are identified by their numeric indices rather than names to save space.
pub fn self_describe(&mut self) -> Result<()>
[src]
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
[src]
Unwrap the Writer
from the Serializer
.
Trait Implementations
impl<'a, W> Serializer for &'a mut Serializer<W> where
W: Write,
[src]
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. Read more
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. Read more
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 returned from [serialize_tuple_struct
] for serializing the content of the tuple struct. Read more
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 returned from [serialize_map
] for serializing the content of the map. Read more
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 returned from [serialize_struct_variant
] for serializing the content of the struct variant. Read more
fn serialize_bool(self, value: bool) -> Result<()>
[src]
Serialize a bool
value. Read more
fn serialize_i8(self, value: i8) -> Result<()>
[src]
Serialize an i8
value. Read more
fn serialize_i16(self, value: i16) -> Result<()>
[src]
Serialize an i16
value. Read more
fn serialize_i32(self, value: i32) -> Result<()>
[src]
Serialize an i32
value. Read more
fn serialize_i64(self, value: i64) -> Result<()>
[src]
Serialize an i64
value. Read more
fn serialize_u8(self, value: u8) -> Result<()>
[src]
Serialize a u8
value. Read more
fn serialize_u16(self, value: u16) -> Result<()>
[src]
Serialize a u16
value. Read more
fn serialize_u32(self, value: u32) -> Result<()>
[src]
Serialize a u32
value. Read more
fn serialize_u64(self, value: u64) -> Result<()>
[src]
Serialize a u64
value. Read more
fn serialize_f32(self, value: f32) -> Result<()>
[src]
Serialize an f32
value. Read more
fn serialize_f64(self, value: f64) -> Result<()>
[src]
Serialize an f64
value. Read more
fn serialize_char(self, value: char) -> Result<()>
[src]
Serialize a character. Read more
fn serialize_str(self, value: &str) -> Result<()>
[src]
Serialize a &str
. Read more
fn serialize_bytes(self, value: &[u8]) -> Result<()>
[src]
Serialize a chunk of raw byte data. Read more
fn serialize_unit(self) -> Result<()>
[src]
Serialize a ()
value. Read more
fn serialize_some<T: ?Sized>(self, value: &T) -> Result<()> where
T: Serialize,
[src]
T: Serialize,
Serialize a [Some(T)
] value. Read more
fn serialize_none(self) -> Result<()>
[src]
Serialize a [None
] value. Read more
fn serialize_unit_struct(self, _name: &'static str) -> Result<()>
[src]
Serialize a unit struct like struct Unit
or PhantomData<T>
. Read more
fn serialize_unit_variant(
self,
_name: &'static str,
variant_index: u32,
variant: &'static str
) -> Result<()>
[src]
self,
_name: &'static str,
variant_index: u32,
variant: &'static str
) -> Result<()>
Serialize a unit variant like E::A
in enum E { A, B }
. Read more
fn serialize_newtype_struct<T: ?Sized>(
self,
_name: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
[src]
self,
_name: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
Serialize a newtype struct like struct Millimeters(u8)
. Read more
fn serialize_newtype_variant<T: ?Sized>(
self,
name: &'static str,
variant_index: u32,
variant: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
[src]
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) }
. Read more
fn serialize_seq(
self,
len: Option<usize>
) -> Result<CollectionSerializer<'a, W>>
[src]
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
. Read more
fn serialize_tuple(self, len: usize) -> Result<&'a mut Serializer<W>>
[src]
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>>
[src]
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>>
[src]
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
fn serialize_map(
self,
len: Option<usize>
) -> Result<CollectionSerializer<'a, W>>
[src]
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
. Read more
fn serialize_struct(
self,
_name: &'static str,
len: usize
) -> Result<StructSerializer<'a, W>>
[src]
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
. Read more
fn serialize_struct_variant(
self,
name: &'static str,
variant_index: u32,
variant: &'static str,
len: usize
) -> Result<StructSerializer<'a, W>>
[src]
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
. Read more
fn is_human_readable(&self) -> bool
[src]
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,
[src]
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
I: IntoIterator<Item = (K, V)>,
K: Serialize,
V: Serialize,
[src]
I: IntoIterator<Item = (K, V)>,
K: Serialize,
V: Serialize,
Collect an iterator as a map. Read more
fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error> where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
Serialize a string produced by an implementation of Display
. Read more
impl<'a, W> SerializeTuple for &'a mut Serializer<W> where
W: Write,
[src]
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: ?Sized>(&mut self, value: &T) -> Result<()> where
T: Serialize,
[src]
T: Serialize,
Serialize a tuple element.
fn end(self) -> Result<()>
[src]
Finish serializing a tuple.
impl<'a, W> SerializeTupleStruct for &'a mut Serializer<W> where
W: Write,
[src]
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: ?Sized>(&mut self, value: &T) -> Result<()> where
T: Serialize,
[src]
T: Serialize,
Serialize a tuple struct field.
fn end(self) -> Result<()>
[src]
Finish serializing a tuple struct.
impl<'a, W> SerializeTupleVariant for &'a mut Serializer<W> where
W: Write,
[src]
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: ?Sized>(&mut self, value: &T) -> Result<()> where
T: Serialize,
[src]
T: Serialize,
Serialize a tuple variant field.
fn end(self) -> Result<()>
[src]
Finish serializing a tuple variant.