Struct yaml_rust2::yaml::YamlDecoder

pub struct YamlDecoder<T: Read> { /* private fields */ }

YamlDecoder is a YamlLoader builder that allows you to supply your own encoding error trap. For example, to read a YAML file while ignoring Unicode decoding errors you can set the encoding_trap to encoding::DecoderTrap::Ignore.

use yaml_rust2::yaml::{YamlDecoder, YAMLDecodingTrap};

let string = b"---
a\xa9: 1
b: 2.2
c: [1, 2]
";
let out = YamlDecoder::read(string as &[u8])
    .encoding_trap(YAMLDecodingTrap::Ignore)
    .decode()
    .unwrap();

Implementations

impl<T: Read> YamlDecoder<T>

pub fn read(source: T) -> YamlDecoder<T>

Create a YamlDecoder decoding the given source.

pub fn encoding_trap(&mut self, trap: YAMLDecodingTrap) -> &mut Self

Set the behavior of the decoder when the encoding is invalid.

pub fn decode(&mut self) -> Result<Vec<Yaml>, LoadError>

Run the decode operation with the source and trap the YamlDecoder was built with.

Errors

Returns LoadError when decoding fails.