Struct Config 

pub struct Config { /* private fields */ }

The main configuration struct that holds parsed configuration data.

Implementations

impl Config

pub fn new(data: ConfigValue) -> Self

Create a new Config from a ConfigValue.

pub fn builder() -> ConfigBuilder

Create a new ConfigBuilder for constructing a Config from multiple sources.

Examples

use prefer::Config;

#[tokio::main]
async fn main() -> prefer::Result<()> {
    let config = Config::builder()
        .add_file("config/default.toml")
        .add_env("MYAPP")
        .build()
        .await?;
    Ok(())
}

pub fn with_source(data: ConfigValue, path: PathBuf) -> Self

Create a new Config with a source path.

pub async fn load(name: &str) -> Result<Self>

Load a configuration file by name.

Searches standard system paths for a configuration file matching the given name with any supported extension.

pub async fn load_from_path(path: &PathBuf) -> Result<Self>

Load a configuration from a specific file path.

pub fn source_path(&self) -> Option<&PathBuf>

Get the source path of this configuration, if available.

pub fn get<T: FromValue>(&self, key: &str) -> Result<T>

Get a configuration value by key using dot notation.

Examples

let username: String = config.get("auth.username")?;
let port: u16 = config.get("server.port")?;
let enabled: bool = config.get("features.logging.enabled")?;

pub fn get_value(&self, key: &str) -> Result<&ConfigValue>

Get a raw configuration value by key using dot notation.

Returns a reference to the ConfigValue at the specified key path.

pub fn data(&self) -> &ConfigValue

Get the entire configuration data as a reference.

pub fn data_mut(&mut self) -> &mut ConfigValue

Get the entire configuration data as a mutable reference.

pub fn has_key(&self, key: &str) -> bool

Check if a key exists in the configuration.

pub fn extract<T: FromValue>(&self, key: &str) -> Result<T>

Extract a value by key using the FromValue trait.

This is an alias for get() for backwards compatibility.

pub fn visit_key<V: ValueVisitor>( &self, key: &str, visitor: &mut V, ) -> Result<V::Output>

Visit a value at the given key with a custom visitor.

This method allows for complex custom deserialization logic using the visitor pattern.

Examples

struct PortVisitor;

impl ValueVisitor for PortVisitor {
    type Output = u16;

    fn visit_i64(&mut self, v: i64) -> Result<Self::Output> {
        u16::try_from(v).map_err(|_| prefer::Error::ConversionError {
            key: String::new(),
            type_name: "u16".into(),
            source: "port out of range".into(),
        })
    }

    fn expecting(&self) -> &'static str {
        "a port number"
    }
}

let port = config.visit_key("server.port", &mut PortVisitor)?;

pub fn visit<V: ValueVisitor>(&self, visitor: &mut V) -> Result<V::Output>

Visit the entire configuration data with a custom visitor.

This is useful for transforming the entire configuration into a custom type.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.