Struct YamlFileAdapter 

pub struct YamlFileAdapter { /* private fields */ }

Configuration source adapter for YAML files.

This adapter reads configuration values from YAML files. It supports automatic discovery of configuration files in OS-appropriate locations, as well as custom file paths.

Priority

YAML files have a priority of 1, which means they are overridden by both environment variables (priority 2) and command-line arguments (priority 3).

Examples

use hexcfg::adapters::YamlFileAdapter;
use hexcfg::ports::ConfigSource;

// Load from a specific file
let adapter = YamlFileAdapter::from_file("/path/to/config.yaml").unwrap();

// Load from default OS location
let adapter = YamlFileAdapter::from_default_location("myapp", "com.example").unwrap();

Implementations

impl YamlFileAdapter

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new YAML file adapter from a specific file path.

Arguments

• path - Path to the YAML file

Examples

use hexcfg::adapters::YamlFileAdapter;

let adapter = YamlFileAdapter::from_file("/etc/myapp/config.yaml").unwrap();

pub fn from_default_location(app_name: &str, qualifier: &str) -> Result<Self>

Creates a new YAML file adapter from the default OS-appropriate location.

This method uses the directories crate to determine the appropriate configuration directory for the current operating system.

Arguments

• app_name - The application name (e.g., “myapp”)
• qualifier - The organization/qualifier (e.g., “com.example”)

Examples

use hexcfg::adapters::YamlFileAdapter;

let adapter = YamlFileAdapter::from_default_location("myapp", "com.example").unwrap();

pub fn with_filename( app_name: &str, qualifier: &str, filename: &str, ) -> Result<Self>

Creates a new YAML file adapter with a custom file name in the default location.

Arguments

• app_name - The application name
• qualifier - The organization/qualifier
• filename - The configuration file name (e.g., “settings.yaml”)

Examples

use hexcfg::adapters::YamlFileAdapter;

let adapter = YamlFileAdapter::with_filename("myapp", "com.example", "settings.yaml").unwrap();

pub fn file_path(&self) -> &Path

Returns the path to the configuration file.

Trait Implementations

impl Clone for YamlFileAdapter

fn clone(&self) -> YamlFileAdapter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigSource for YamlFileAdapter

fn name(&self) -> &str

Returns the name of this configuration source.

fn priority(&self) -> u8

Returns the priority of this configuration source.

fn get(&self, key: &ConfigKey) -> Result<Option<ConfigValue>>

Retrieves a configuration value for the given key.

fn all_keys(&self) -> Result<Vec<ConfigKey>>

Returns all configuration keys available in this source.

fn reload(&mut self) -> Result<()>

Reloads the configuration from the source.

fn get_str(&self, key: &str) -> Result<Option<ConfigValue>>

Retrieves a configuration value for the given key string.

impl Debug for YamlFileAdapter

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

Formats the value using the given formatter.