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,

source

pub fn new(writer: W) -> Self

Creates a new YAML serializer.

source

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

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

source

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

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

Trait Implementations§

source§

impl<'a, W> SerializeMap for &'a 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.
source§

fn serialize_key<T>(&mut self, key: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a map key. Read more
source§

fn serialize_value<T>(&mut self, value: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a map value. Read more
source§

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. Read more
source§

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

Finish serializing a map.
source§

impl<'a, W> SerializeSeq for &'a 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.
source§

fn serialize_element<T>(&mut self, elem: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a sequence element.
source§

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

Finish serializing a sequence.
source§

impl<'a, W> SerializeStruct for &'a 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.
source§

fn serialize_field<V>( &mut self, key: &'static str, value: &V, ) -> Result<(), Error>
where V: ?Sized + Serialize,

Serialize a struct field.
source§

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

Finish serializing a struct.
source§

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

Indicate that a struct field has been skipped. Read more
source§

impl<'a, W> SerializeStructVariant for &'a 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.
source§

fn serialize_field<V>( &mut self, field: &'static str, v: &V, ) -> Result<(), Error>
where V: ?Sized + Serialize,

Serialize a struct variant field.
source§

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

Finish serializing a struct variant.
source§

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

Indicate that a struct variant field has been skipped. Read more
source§

impl<'a, W> SerializeTuple for &'a 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.
source§

fn serialize_element<T>(&mut self, elem: &T) -> Result<(), Error>
where T: ?Sized + Serialize,

Serialize a tuple element.
source§

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

Finish serializing a tuple.
source§

impl<'a, W> SerializeTupleStruct for &'a 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.
source§

fn serialize_field<V>(&mut self, value: &V) -> Result<(), Error>
where V: ?Sized + Serialize,

Serialize a tuple struct field.
source§

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

Finish serializing a tuple struct.
source§

impl<'a, W> SerializeTupleVariant for &'a 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.
source§

fn serialize_field<V>(&mut self, v: &V) -> Result<(), Error>
where V: ?Sized + Serialize,

Serialize a tuple variant field.
source§

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

Finish serializing a tuple variant.
source§

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

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

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 returned from serialize_tuple_struct for serializing the content of the tuple struct.
§

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 returned from serialize_map for serializing the content of the map.
§

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 returned from serialize_struct_variant for serializing the content of the struct variant.
source§

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

Serialize a bool value. Read more
source§

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

Serialize an i8 value. Read more
source§

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

Serialize an i16 value. Read more
source§

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

Serialize an i32 value. Read more
source§

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

Serialize an i64 value. Read more
source§

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

Serialize an i128 value. Read more
source§

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

Serialize a u8 value. Read more
source§

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

Serialize a u16 value. Read more
source§

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

Serialize a u32 value. Read more
source§

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

Serialize a u64 value. Read more
source§

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

Serialize a u128 value. Read more
source§

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

Serialize an f32 value. Read more
source§

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

Serialize an f64 value. Read more
source§

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

Serialize a character. Read more
source§

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

Serialize a &str. Read more
source§

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

Serialize a chunk of raw byte data. Read more
source§

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

Serialize a () value. Read more
source§

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

Serialize a unit struct like struct Unit or PhantomData<T>. Read more
source§

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 }. Read more
source§

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). Read more
source§

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) }. Read more
source§

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

Serialize a None value. Read more
source§

fn serialize_some<V>(self, value: &V) -> Result<(), Error>
where V: ?Sized + Serialize,

Serialize a Some(T) value. Read more
source§

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 more
source§

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 more
source§

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 more
source§

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 more
source§

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 more
source§

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 more
source§

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 more
source§

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Error>
where T: ?Sized + Display,

Serialize a string produced by an implementation of Display. Read more
source§

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>
where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map. Read more
source§

fn is_human_readable(&self) -> bool

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

Auto 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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.