Struct Yaml 

pub struct Yaml;

Figment [Format] for noyalib YAML.

Build a provider via Yaml::string(yaml_text), Yaml::file(path), or any of the other [Format] constructors inherited from the trait. The result implements [figment::Provider] and slots into Figment::merge / Figment::join chains.

These providers parse under the default ParserConfig: a source over max_document_length is refused, and a file is read no further than one byte past that limit. Use Yaml::string_with_config or Yaml::file_with_config to parse under other limits or policies.

Implementations

impl Yaml

pub fn string_with_config(yaml: &str, config: ParserConfig) -> YamlWithConfig

A provider that parses yaml under config, for limits or policies other than the defaults. Emits to the default profile unless YamlWithConfig::nested or YamlWithConfig::profile says otherwise, like [Format::string].

Examples

use figment::Figment;
use noyalib::ParserConfig;
use noyalib::figment::Yaml;

#[derive(serde::Deserialize)]
struct Config {
    port: u16,
}

let provider = Yaml::string_with_config("port: 8080\n", ParserConfig::strict());
let cfg: Config = Figment::new().merge(provider).extract().unwrap();
assert_eq!(cfg.port, 8080);

pub fn file_with_config<P: AsRef<Path>>( path: P, config: ParserConfig, ) -> YamlWithConfig

A provider that reads and parses the file at path under config. The path is used as given (no search of parent directories, unlike [Format::file]); a missing file is an error. Reading stops one byte past max_document_length.

Trait Implementations

impl Clone for Yaml

fn clone(&self) -> Yaml

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Yaml

impl Debug for Yaml

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

Formats the value using the given formatter.

impl Format for Yaml

const NAME: &'static str = "YAML"

The name of the data format, for instance "JSON" or "TOML".

type Error = Error

The data format’s error type.

fn from_str<T: DeserializeOwned>(s: &str) -> Result<T, Self::Error>

Parses string as the data format Self as a T or returns an error if the string is an invalid T. Note: This method is not intended to be called directly. Instead, it is intended to be implemented and then used indirectly via the [Data::file()] or [Data::string()] methods.

fn from_path<T: DeserializeOwned>(path: &Path) -> Result<T, Self::Error>

Parses the file at path as the data format Self as a T or returns an error if the string is an invalid T. The default implementation calls [Format::from_str()] with the contents of the file. Note: This method is not intended to be called directly. Instead, it is intended to be implemented on special occasions and then used indirectly via the [Data::file()] or [Data::string()] methods.

fn file<P>(path: P) -> Data<Self>

where P: AsRef<Path>,

Returns a Data provider that sources its values by parsing the file at path as format Self. See [Data::file()] for more details. The default implementation calls Data::file(path).

fn file_exact<P>(path: P) -> Data<Self>

where P: AsRef<Path>,

Returns a Data provider that sources its values by parsing the file at path as format Self. See [Data::file_exact()] for more details. The default implementation calls Data::file_exact(path).

fn string(string: &str) -> Data<Self>

Returns a Data provider that sources its values by parsing string as format Self. See [Data::string()] for more details. The default implementation calls Data::string(string).