Struct yaml_rust2::yaml::YamlDecoder

source ·
pub struct YamlDecoder<T: Read> { /* private fields */ }
Expand description

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§

source§

impl<T: Read> YamlDecoder<T>

source

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

Create a YamlDecoder decoding the given source.

source

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

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

source

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.

Auto Trait Implementations§

§

impl<T> Freeze for YamlDecoder<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for YamlDecoder<T>
where T: RefUnwindSafe,

§

impl<T> Send for YamlDecoder<T>
where T: Send,

§

impl<T> Sync for YamlDecoder<T>
where T: Sync,

§

impl<T> Unpin for YamlDecoder<T>
where T: Unpin,

§

impl<T> UnwindSafe for YamlDecoder<T>
where T: UnwindSafe,

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.