Struct Serializer

pub struct Serializer<W> {
    pub config: SerializerConfig,
    pub depth: usize,
    pub state: State,
    pub emitter: Emitter<'static>,
    pub writer: PhantomData<W>,
}

A structure for serializing Rust values into YAML.

Example

use serde::Serialize;
use std::collections::BTreeMap;

fn main() -> serde_yml::Result<()> {
    let mut buffer = Vec::new();
    let mut ser = serde_yml::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(())
}

Fields

config: SerializerConfig

The configuration of the serializer.

depth: usize

The depth of the current serialization.

state: State

The current state of the serializer.

emitter: Emitter<'static>

The YAML emitter.

writer: PhantomData<W>

The underlying writer.

Implementations

impl<W> Serializer<W>

where W: Write,

pub fn new(writer: W) -> Self

Creates a new YAML serializer.

pub fn new_with_config(writer: W, config: SerializerConfig) -> Self

Creates a new YAML serializer with a configuration.

pub fn flush(&mut self) -> Result<(), Error>

Calls .flush() on the underlying io::Write object.

pub fn into_inner(self) -> Result<W, Error>

Unwrap the underlying io::Write object from the Serializer.

pub fn emit_scalar(&mut self, scalar: Scalar<'_>) -> Result<(), Error>

Emit a scalar value.

pub fn emit_sequence_start(&mut self) -> Result<(), Error>

Emit a sequence start.

pub fn emit_sequence_end(&mut self) -> Result<(), Error>

Emit a sequence end.

pub fn emit_mapping_start(&mut self) -> Result<(), Error>

Emit a mapping start.

pub fn emit_mapping_end(&mut self) -> Result<(), Error>

Emit a mapping end.

pub fn value_start(&mut self) -> Result<(), Error>

Emit a value start.

pub fn value_end(&mut self) -> Result<(), Error>

Emit a value end.

pub fn take_tag(&mut self) -> Option<String>

Take the tag if it exists.

pub fn flush_mapping_start(&mut self) -> Result<(), Error>

Flush the mapping start.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<W> SerializeMap for &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_key<T>(&mut self, key: &T) -> Result<(), Error>

where T: ?Sized + Serialize,

Serialize a map key.

fn serialize_value<T>(&mut self, value: &T) -> Result<(), Error>

where T: ?Sized + Serialize,

Serialize a map value.

fn serialize_entry<K, V>( &mut self, key: &K, value: &V, ) -> Result<(), Self::Error>

where K: ?Sized + Serialize, V: ?Sized + Serialize,

Serialize a map entry consisting of a key and a value.

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

Finish serializing a map.

impl<W> SerializeSeq for &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, elem: &T) -> Result<(), Error>

where T: ?Sized + Serialize,

Serialize a sequence element.

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

Finish serializing a sequence.

impl<W> SerializeStruct for &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<V>( &mut self, key: &'static str, value: &V, ) -> Result<(), Error>

where V: ?Sized + Serialize,

Serialize a struct field.

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

Finish serializing a struct.

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct field has been skipped.

impl<W> SerializeStructVariant for &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<V>( &mut self, field: &'static str, v: &V, ) -> Result<(), Error>

where V: ?Sized + Serialize,

Serialize a struct variant field.

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

Finish serializing a struct variant.

fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error>

Indicate that a struct variant field has been skipped.

impl<W> SerializeTuple for &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, elem: &T) -> Result<(), Error>

where T: ?Sized + Serialize,

Serialize a tuple element.

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

Finish serializing a tuple.

impl<W> SerializeTupleStruct for &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<V>(&mut self, value: &V) -> Result<(), Error>

where V: ?Sized + Serialize,

Serialize a tuple struct field.

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

Finish serializing a tuple struct.

impl<W> SerializeTupleVariant for &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<V>(&mut self, v: &V) -> Result<(), Error>

where V: ?Sized + Serialize,

Serialize a tuple variant field.

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

Finish serializing a tuple variant.

impl<W> Serializer for &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 = &mut Serializer<W>

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

type SerializeTuple = &mut Serializer<W>

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

type SerializeTupleStruct = &mut Serializer<W>

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

type SerializeTupleVariant = &mut Serializer<W>

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

type SerializeMap = &mut Serializer<W>

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

type SerializeStruct = &mut Serializer<W>

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

type SerializeStructVariant = &mut Serializer<W>

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

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

Serialize a bool value.

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

Serialize an i8 value.

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

Serialize an i16 value.

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

Serialize an i32 value.

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

Serialize an i64 value.

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

Serialize an i128 value.

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

Serialize a u8 value.

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

Serialize a u16 value.

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

Serialize a u32 value.

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

Serialize a u64 value.

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

Serialize a u128 value.

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

Serialize an f32 value.

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

Serialize an f64 value.

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

Serialize a character.

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

Serialize a &str.

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

Serialize a chunk of raw byte data.

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

Serialize a () value.

fn serialize_unit_struct(self, _name: &'static str) -> Result<(), Error>

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<(), Error>

Serialize a unit variant like E::A in enum E { A, B }.

fn serialize_newtype_struct<T>( self, _name: &'static str, value: &T, ) -> Result<(), Error>

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<(), Error>

where T: ?Sized + Serialize,

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

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

Serialize a None value.

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

where V: ?Sized + Serialize,

Serialize a Some(T) value.

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.

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.

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.

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.

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.

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.

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.

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

where T: ?Sized + Display,

Serialize a string produced by an implementation of Display.

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

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