Struct bincode::Serializer
source · [−]pub struct Serializer<W, O: Options> { /* private fields */ }
Expand description
An Serializer that encodes values directly into a Writer.
The specified byte-order will impact the endianness that is used during the encoding.
This struct should not be used often.
For most cases, prefer the encode_into
function.
Implementations
sourceimpl<W: Write, O: Options> Serializer<W, O>
impl<W: Write, O: Options> Serializer<W, O>
sourcepub fn new(w: W, options: O) -> Serializer<W, O>
pub fn new(w: W, options: O) -> Serializer<W, O>
Creates a new Serializer with the given Write
r.
Trait Implementations
sourceimpl<'a, W: Write, O: Options> Serializer for &'a mut Serializer<W, O>
impl<'a, W: Write, O: Options> Serializer for &'a mut Serializer<W, O>
type Ok = ()
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 SerializeSeq = Compound<'a, W, O>
type SerializeSeq = Compound<'a, W, O>
Type returned from serialize_seq
for serializing the content of the
sequence. Read more
type SerializeTuple = Compound<'a, W, O>
type SerializeTuple = Compound<'a, W, O>
Type returned from serialize_tuple
for serializing the content of
the tuple. Read more
type SerializeTupleStruct = Compound<'a, W, O>
type SerializeTupleStruct = Compound<'a, W, O>
Type returned from serialize_tuple_struct
for serializing the
content of the tuple struct. Read more
type SerializeTupleVariant = Compound<'a, W, O>
type SerializeTupleVariant = Compound<'a, W, O>
Type returned from serialize_tuple_variant
for serializing the
content of the tuple variant. Read more
type SerializeMap = Compound<'a, W, O>
type SerializeMap = Compound<'a, W, O>
Type returned from serialize_map
for serializing the content of the
map. Read more
type SerializeStruct = Compound<'a, W, O>
type SerializeStruct = Compound<'a, W, O>
Type returned from serialize_struct
for serializing the content of
the struct. Read more
type SerializeStructVariant = Compound<'a, W, O>
type SerializeStructVariant = Compound<'a, W, O>
Type returned from serialize_struct_variant
for serializing the
content of the struct variant. Read more
sourcefn serialize_unit(self) -> Result<()>
fn serialize_unit(self) -> Result<()>
Serialize a ()
value. Read more
sourcefn serialize_unit_struct(self, _: &'static str) -> Result<()>
fn serialize_unit_struct(self, _: &'static str) -> Result<()>
Serialize a unit struct like struct Unit
or PhantomData<T>
. Read more
sourcefn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq>
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
. Read more
sourcefn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple>
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
. Read more
sourcefn serialize_tuple_struct(
self,
_name: &'static str,
_len: usize
) -> Result<Self::SerializeTupleStruct>
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
. Read more
sourcefn serialize_tuple_variant(
self,
_name: &'static str,
variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeTupleVariant>
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
. Read more
sourcefn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap>
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
. Read more
sourcefn serialize_struct(
self,
_name: &'static str,
_len: usize
) -> Result<Self::SerializeStruct>
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
. Read more
sourcefn serialize_struct_variant(
self,
_name: &'static str,
variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeStructVariant>
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
. Read more
sourcefn serialize_newtype_struct<T: ?Sized>(
self,
_name: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
fn serialize_newtype_struct<T: ?Sized>(
self,
_name: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
Serialize a newtype struct like struct Millimeters(u8)
. Read more
sourcefn serialize_newtype_variant<T: ?Sized>(
self,
_name: &'static str,
variant_index: u32,
_variant: &'static str,
value: &T
) -> Result<()> where
T: Serialize,
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) }
. Read more
sourcefn serialize_unit_variant(
self,
_name: &'static str,
variant_index: u32,
_variant: &'static str
) -> Result<()>
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 }
. Read more
sourcefn is_human_readable(&self) -> bool
fn is_human_readable(&self) -> bool
Determine whether Serialize
implementations should serialize in
human-readable form. Read more
sourcefn 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
Auto Trait Implementations
impl<W, O> RefUnwindSafe for Serializer<W, O> where
O: RefUnwindSafe,
W: RefUnwindSafe,
impl<W, O> Send for Serializer<W, O> where
O: Send,
W: Send,
impl<W, O> Sync for Serializer<W, O> where
O: Sync,
W: Sync,
impl<W, O> Unpin for Serializer<W, O> where
O: Unpin,
W: Unpin,
impl<W, O> UnwindSafe for Serializer<W, O> where
O: UnwindSafe,
W: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more