Struct yaml_rust2::emitter::YamlEmitter

pub struct YamlEmitter<'a> { /* private fields */ }

The YAML serializer.

let input_string = "a: b\nc: d";
let yaml = YamlLoader::load_from_str(input_string).unwrap();

let mut output = String::new();
YamlEmitter::new(&mut output).dump(&yaml[0]).unwrap();

assert_eq!(output, r#"---
a: b
c: d"#);

Implementations

impl<'a> YamlEmitter<'a>

pub fn new(writer: &'a mut dyn Write) -> YamlEmitter<'_>

Create a new emitter serializing into writer.

pub fn compact(&mut self, compact: bool)

Set ‘compact inline notation’ on or off, as described for block sequences and mappings.

In this form, blocks cannot have any properties (such as anchors or tags), which should be OK, because this emitter doesn’t (currently) emit those anyways.

pub fn is_compact(&self) -> bool

Determine if this emitter is using ‘compact inline notation’.

pub fn multiline_strings(&mut self, multiline_strings: bool)

Render strings containing multiple lines in literal style.

Examples

use yaml_rust2::{Yaml, YamlEmitter, YamlLoader};

let input = r#"{foo: "bar!\nbar!", baz: 42}"#;
let parsed = YamlLoader::load_from_str(input).unwrap();
eprintln!("{:?}", parsed);

let mut output = String::new();
let mut emitter = YamlEmitter::new(&mut output);
emitter.multiline_strings(true);
emitter.dump(&parsed[0]).unwrap();
assert_eq!(output.as_str(), "\
---
foo: |
  bar!
  bar!
baz: 42");

pub fn is_multiline_strings(&self) -> bool

Determine if this emitter will emit multiline strings when appropriate.

pub fn dump(&mut self, doc: &Yaml) -> EmitResult

Dump Yaml to an output stream.

Errors

Returns EmitError when an error occurs.