yaml_include/lib.rs
1#![warn(missing_docs)]
2//! Processing yaml with include documents through `!include <path>` tag.
3//!
4//! ## Features
5//!
6//! - include and parse recursively `yaml` (and `json`) files
7//! - include `markdown` and `txt` text files
8//! - include other types as `base64` encoded binary data.
9//! - optionaly handle gracefully circular references with `!circular` tag
10//!
11//! ## Example
12//! ```
13//! use std::path::PathBuf;
14//! use yaml_include::Transformer;
15//!
16//! let path = PathBuf::from("data/sample/main.yml");
17//! if let Ok(transformer) = Transformer::new(path, false) {
18//! println!("{}", transformer);
19//! };
20//! ```
21mod helpers;
22mod transformer;
23
24pub use transformer::*;