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§

Creates a new YAML serializer.

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

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

Trait Implementations§

Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a map key. Read more
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
Finish serializing a map.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a sequence element.
Finish serializing a sequence.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a struct field.
Finish serializing a struct.
Indicate that a struct field has been skipped.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a struct variant field.
Finish serializing a struct variant.
Indicate that a struct variant field has been skipped.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a tuple element.
Finish serializing a tuple.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a tuple struct field.
Finish serializing a tuple struct.
Must match the Ok type of our Serializer.
Must match the Error type of our Serializer.
Serialize a tuple variant field.
Finish serializing a tuple variant.
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.
The error type when some error occurs during serialization.
Type returned from serialize_seq for serializing the content of the sequence.
Type returned from serialize_tuple for serializing the content of the tuple.
Type returned from serialize_tuple_struct for serializing the content of the tuple struct.
Type returned from serialize_tuple_variant for serializing the content of the tuple variant.
Type returned from serialize_map for serializing the content of the map.
Type returned from serialize_struct for serializing the content of the struct.
Type returned from serialize_struct_variant for serializing the content of the struct variant.
Serialize a bool value. Read more
Serialize an i8 value. Read more
Serialize an i16 value. Read more
Serialize an i32 value. Read more
Serialize an i64 value. Read more
Serialize an i128 value. Read more
Serialize a u8 value. Read more
Serialize a u16 value. Read more
Serialize a u32 value. Read more
Serialize a u64 value. Read more
Serialize a u128 value. Read more
Serialize an f32 value. Read more
Serialize an f64 value. Read more
Serialize a character. Read more
Serialize a &str. Read more
Serialize a chunk of raw byte data. Read more
Serialize a () value. Read more
Serialize a unit struct like struct Unit or PhantomData<T>. Read more
Serialize a unit variant like E::A in enum E { A, B }. Read more
Serialize a newtype struct like struct Millimeters(u8). Read more
Serialize a newtype variant like E::N in enum E { N(u8) }. Read more
Serialize a None value. Read more
Serialize a Some(T) value. Read more
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
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
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
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
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
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
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
Serialize a string produced by an implementation of Display. Read more
Collect an iterator as a sequence. Read more
Collect an iterator as a map. Read more
Determine whether Serialize implementations should serialize in human-readable form. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.