Struct yaml_rust2::yaml::YamlLoader

source ·
pub struct YamlLoader { /* private fields */ }
Expand description

Main structure for quickly parsing YAML.

See YamlLoader::load_from_str.

Implementations§

source§

impl YamlLoader

source

pub fn load_from_str(source: &str) -> Result<Vec<Yaml>, ScanError>

Load the given string as a set of YAML documents.

The source is interpreted as YAML documents and is parsed. Parsing succeeds if and only if all documents are parsed successfully. An error in a latter document prevents the former from being returned.

§Errors

Returns ScanError when loading fails.

source

pub fn load_from_iter<I: Iterator<Item = char>>( source: I ) -> Result<Vec<Yaml>, ScanError>

Load the contents of the given iterator as a set of YAML documents.

The source is interpreted as YAML documents and is parsed. Parsing succeeds if and only if all documents are parsed successfully. An error in a latter document prevents the former from being returned.

§Errors

Returns ScanError when loading fails.

source

pub fn load_from_parser<I: Iterator<Item = char>>( parser: &mut Parser<I> ) -> Result<Vec<Yaml>, ScanError>

Load the contents from the specified Parser as a set of YAML documents.

Parsing succeeds if and only if all documents are parsed successfully. An error in a latter document prevents the former from being returned.

§Errors

Returns ScanError when loading fails.

source

pub fn documents(&self) -> &[Yaml]

Return a reference to the parsed Yaml documents.

Trait Implementations§

source§

impl Default for YamlLoader

source§

fn default() -> YamlLoader

Returns the “default value” for a type. Read more
source§

impl MarkedEventReceiver for YamlLoader

source§

fn on_event(&mut self, ev: Event, mark: Marker)

Handler called for each event that occurs.

Auto Trait Implementations§

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.