Struct Transformer

pub struct Transformer { /* private fields */ }

Processing yaml with include documents through !include <path> tag.

Features

• include and parse recursively yaml (and json) files
• include markdown and txt text files
• include other types as base64 encoded binary data.
• optionaly handle gracefully circular references with !circular tag

Example

use std::path::PathBuf;
use yaml_include::Transformer;

let path = PathBuf::from("data/sample/main.yml");
if let Ok(transformer) = Transformer::new(path, false) {
    println!("{}", transformer);
};

Implementations

impl Transformer

pub fn new(root_path: PathBuf, strict: bool) -> Result<Self>

Instance a transformer from a yaml file path.

Example:

use std::path::PathBuf;
use yaml_include::Transformer;

let path = PathBuf::from("data/sample/main.yml");
if let Ok(transformer) = Transformer::new(path, false) {
    dbg!(transformer);
};

pub fn parse(&self) -> Value

Parse yaml with recursively processing !include

Example:

use std::path::PathBuf;
use yaml_include::Transformer;

let path = PathBuf::from("data/sample/main.yml");
if let Ok(transformer) = Transformer::new(path, false) {
    let parsed = transformer.parse();
    dbg!(parsed);
};

Trait Implementations

impl Clone for Transformer

fn clone(&self) -> Transformer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transformer

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

Formats the value using the given formatter.

impl Display for Transformer

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

Formats the value using the given formatter.