Struct serde_yaml::Serializer
source · pub struct Serializer<W> { /* private fields */ }
Expand description
A structure for serializing Rust values into YAML.
§Example
use anyhow::Result;
use serde::Serialize;
use std::collections::BTreeMap;
fn main() -> Result<()> {
let mut buffer = Vec::new();
let mut ser = serde_yaml::Serializer::new(&mut buffer);
let mut object = BTreeMap::new();
object.insert("k", 107);
object.serialize(&mut ser)?;
object.insert("J", 74);
object.serialize(&mut ser)?;
assert_eq!(buffer, b"k: 107\n---\nJ: 74\nk: 107\n");
Ok(())
}
Implementations§
source§impl<W> Serializer<W>where
W: Write,
impl<W> Serializer<W>where
W: Write,
Trait Implementations§
source§impl<'a, W> SerializeMap for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeMap for &'a mut Serializer<W>where
W: Write,
source§fn serialize_value<T>(&mut self, value: &T) -> Result<(), Error>
fn serialize_value<T>(&mut self, value: &T) -> Result<(), Error>
Serialize a map value. Read more
source§impl<'a, W> SerializeSeq for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeSeq for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> SerializeStruct for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeStruct for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> SerializeStructVariant for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeStructVariant for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> SerializeTuple for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeTuple for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> SerializeTupleStruct for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeTupleStruct for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> SerializeTupleVariant for &'a mut Serializer<W>where
W: Write,
impl<'a, W> SerializeTupleVariant for &'a mut Serializer<W>where
W: Write,
source§impl<'a, W> Serializer for &'a mut Serializer<W>where
W: Write,
impl<'a, W> Serializer for &'a mut Serializer<W>where
W: Write,
§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.§type SerializeSeq = &'a mut Serializer<W>
type SerializeSeq = &'a mut Serializer<W>
Type returned from
serialize_seq
for serializing the content of the
sequence.§type SerializeTuple = &'a mut Serializer<W>
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 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 SerializeTupleVariant = &'a mut Serializer<W>
Type returned from
serialize_tuple_variant
for serializing the
content of the tuple variant.§type SerializeMap = &'a mut Serializer<W>
type SerializeMap = &'a mut Serializer<W>
Type returned from
serialize_map
for serializing the content of the
map.§type SerializeStruct = &'a mut Serializer<W>
type SerializeStruct = &'a mut Serializer<W>
Type returned from
serialize_struct
for serializing the content of
the struct.§type SerializeStructVariant = &'a mut Serializer<W>
type SerializeStructVariant = &'a mut Serializer<W>
Type returned from
serialize_struct_variant
for serializing the
content of the struct variant.source§fn serialize_bytes(self, _value: &[u8]) -> Result<(), Error>
fn serialize_bytes(self, _value: &[u8]) -> Result<(), Error>
Serialize a chunk of raw byte data. Read more
source§fn serialize_unit_variant(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
) -> Result<(), Error>
fn serialize_unit_variant( self, _name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result<(), Error>
source§fn serialize_newtype_struct<T>(
self,
_name: &'static str,
value: &T,
) -> Result<(), Error>
fn serialize_newtype_struct<T>( self, _name: &'static str, value: &T, ) -> Result<(), Error>
Serialize a newtype struct like
struct Millimeters(u8)
. Read moresource§fn serialize_newtype_variant<T>(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
value: &T,
) -> Result<(), Error>
fn serialize_newtype_variant<T>( self, _name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<(), Error>
source§fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Error>
fn serialize_seq(self, _len: Option<usize>) -> Result<Self::SerializeSeq, Error>
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 moresource§fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple, Error>
fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple, Error>
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 moresource§fn serialize_tuple_struct(
self,
_name: &'static str,
_len: usize,
) -> Result<Self::SerializeTupleStruct, Error>
fn serialize_tuple_struct( self, _name: &'static str, _len: usize, ) -> Result<Self::SerializeTupleStruct, Error>
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 moresource§fn serialize_tuple_variant(
self,
_enm: &'static str,
_idx: u32,
variant: &'static str,
_len: usize,
) -> Result<Self::SerializeTupleVariant, Error>
fn serialize_tuple_variant( self, _enm: &'static str, _idx: u32, variant: &'static str, _len: usize, ) -> Result<Self::SerializeTupleVariant, Error>
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 moresource§fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap, Error>
fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap, Error>
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 moresource§fn serialize_struct(
self,
_name: &'static str,
_len: usize,
) -> Result<Self::SerializeStruct, Error>
fn serialize_struct( self, _name: &'static str, _len: usize, ) -> Result<Self::SerializeStruct, Error>
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 moresource§fn serialize_struct_variant(
self,
_enm: &'static str,
_idx: u32,
variant: &'static str,
_len: usize,
) -> Result<Self::SerializeStructVariant, Error>
fn serialize_struct_variant( self, _enm: &'static str, _idx: u32, variant: &'static str, _len: usize, ) -> Result<Self::SerializeStructVariant, Error>
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 moresource§fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Error>
fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Error>
Serialize a string produced by an implementation of
Display
. Read moresource§fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>
fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>
Collect an iterator as a sequence. Read more
source§fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>
fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>
Collect an iterator as a map. Read more
source§fn is_human_readable(&self) -> bool
fn is_human_readable(&self) -> bool
Determine whether
Serialize
implementations should serialize in
human-readable form. Read moreAuto Trait Implementations§
impl<W> Freeze for Serializer<W>
impl<W> !RefUnwindSafe for Serializer<W>
impl<W> !Send for Serializer<W>
impl<W> !Sync for Serializer<W>
impl<W> Unpin for Serializer<W>where
W: Unpin,
impl<W> !UnwindSafe for Serializer<W>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more