Skip to main content

Loader

Struct Loader 

Source
pub struct Loader {
    pub options: Options,
}
Expand description

Loads and merges the config sources named by its Options.

Fields§

§options: Options

Implementations§

Source§

impl Loader

Source

pub fn new(options: Options) -> Self

Everything — sources included — comes in through Options; there is no separate builder step.

Source

pub fn load<T: DeserializeOwned>(&self) -> Result<T>

Load and merge all sources, deserializing into T.

Value implements Deserialize, so T = Value gives dynamic access and any other serde type gives typed config. A Value — the whole result, or a field of your struct — is handed over as merged, typed variants (DateTime, Ipv4, …) included, exactly as Loader::trace shows them.

A string reaching a bool, integer or float field parses with the rules of that table type id (u16, bool, … — see the crate docs’ table section), so ini, env and cnf values, which are all strings, load into typed fields. The explicit bool tokens apply (yes/no, on/off, 1/0, …), and out-of-range or malformed text is Error::Deserialize ('70000' is not a valid u16). Untyped targets (Value, String) keep the string.

The reverse holds too: a number or bool reaching a String field becomes its text (password: 123456 → "123456"; a float in its shortest round-trip form, so 1.0 stays "1.0").

Every Error::Deserialize names the key path it failed at — db.password: invalid type: …, items[2].id: …. An empty value (PORT=) cannot fill a number or bool field, not even an Option one (serde picks None or Some before it sees the inner type); the error says to remove the line instead.

To type one part of a loaded Value, use Value::into_typed.

#[derive(serde::Deserialize)]
struct Server {
    port: u16,
    debug: bool,
}

// the 1-tuple value source stands in for an ini/env/cnf file here
let server: Server = c4::Loader::new(c4::Options {
    sources: vec![(serde_json::json!({ "port": "8080", "debug": "yes" }),).into()],
    ..c4::Options::default()
})
.load()?;
assert_eq!(server.port, 8080);
assert!(server.debug);

Warnings are dropped — call Loader::trace to see why some input was not used (a skipped cnf !include, for instance).

Source

pub fn trace(&self) -> Result<Trace>

Like Loader::load, but keeps per-leaf provenance and the Warnings — see Trace. This powers the CLI --trace mode; source labels are a debug/testing aid, not config data.

use c4::{CustomFormat, Loader, TracedValue};

// a custom-format string source keeps this example runnable
// under every feature combination (`Loader::default()` would
// read ./config instead)
let kv = CustomFormat::new("kv", ["kv"], |text, path, options| {
    let rows = text
        .lines()
        .map(|line| line.split('=').map(str::to_owned).collect())
        .collect();
    c4::parse_table(rows, &c4::TableLayout::Kv, path, options)
});

let trace = Loader::new(c4::Options {
    sources: vec![(kv, "port=8080").into()],
    ..c4::Options::default()
})
.trace()?;
assert!(trace.warnings.is_empty());
let TracedValue::Object(root) = &trace.value else { unreachable!() };
let TracedValue::Leaf { value, source } = &root["port"] else { unreachable!() };
assert_eq!(value.as_u64(), Some(8080));
assert_eq!(source, &c4::SourceRef::String(0)); // "string:0" in traces

Trait Implementations§

Source§

impl Clone for Loader

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Loader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Loader

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.