Struct Serializer 

pub struct Serializer { /* private fields */ }

Serializes values into YAML documents.

Every call to serialize writes a document, documents after the first start with ---.

use deser_yaml::Serializer;

let mut serializer = Serializer::new();
serializer.serialize(&"a").unwrap();
serializer.serialize(&vec![1, 2]).unwrap();
assert_eq!(serializer.finish(), "a\n---\n- 1\n- 2\n");

The serializer is also the stream serializer of YAML (see StreamSerializer): the output can be taken while documents are written, and large documents can be written in parts. To write to a Write use SerializerConfig::writer.

Implementations

impl Serializer

pub fn new() -> Serializer

Creates a serializer.

pub fn with_config(config: SerializerConfig) -> Serializer

Creates a serializer with the given configuration.

pub fn with_written(config: SerializerConfig, written: usize) -> Serializer

Creates a serializer for a stream that continues after the given number of documents.

This is useful to append to a stream that was written before: the next document starts with ---.

pub fn config(&self) -> &SerializerConfig

Returns the configuration.

pub fn written(&self) -> usize

Returns the number of documents that were written.

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

Serializes a value.

If the value fails to serialize, nothing is written.

pub fn serialize_with<F, T: Serialize + ?Sized>( &mut self, value: &T, setup: F, ) -> Result<(), Error>

where F: FnOnce(&mut SerializeDriver<'_>),

Serializes a value with a configured driver.

The callback is invoked with the driver before the value is serialized, for instance to add Layers.

pub fn as_str(&self) -> &str

Returns the documents written so far (that were not cleared).

pub fn finish(self) -> String

Returns the documents.

Trait Implementations

impl Clone for Serializer

fn clone(&self) -> Serializer

Clones the serializer.

The clone of a serializer that writes a document in parts cannot write more documents (see StreamSerializer::in_progress).

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Serializer

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

Formats the value using the given formatter.

impl Default for Serializer

fn default() -> Serializer

Returns the “default value” for a type.

impl Serializer for Serializer

fn drive(&mut self, driver: &mut SerializeDriver<'_>) -> Result<(), Error>

Receives the events of a value from the driver and writes them into the output.

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

where T: Serialize + ?Sized, Self: Sized,

Serializes a value.

fn serialize_with<T, F>(&mut self, value: &T, setup: F) -> Result<(), Error>

where T: Serialize + ?Sized, F: FnOnce(&mut SerializeDriver<'_>), Self: Sized,

Serializes a value with a configured driver.

fn serialize_ref(&mut self, value: SerializeRef<'_>) -> Result<(), Error>

Serializes the value of a reference.

impl StreamSerializer for Serializer

fn output(&self) -> &[u8]

Returns the bytes serialized so far which were not cleared yet.

fn clear_output(&mut self)

Discards the bytes returned by output, for instance because they were written.

fn supports_partial(&self) -> bool

Returns true if the serializer implements drive_partial.

fn drive_partial( &mut self, driver: &mut SerializeDriver<'_>, limit: usize, ) -> Result<bool, Error>

Serializes a value, or a part of it, and appends its bytes to the output.

fn in_progress(&self) -> bool

Returns true if a value is partially serialized.