Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

A resolved configuration: a flat map of dotted keys to string values, plus the precedence machinery to overlay env and flags.

Implementations§

Source§

impl Config

Source

pub fn new() -> Self

Source

pub fn env_prefix<S: Into<String>>(self, prefix: S) -> Self

Set an environment-variable prefix used by Config::get to overlay env values. With prefix MYTOOL, key port reads MYTOOL_PORT.

Source

pub fn set<K: Into<String>, V: Into<String>>( &mut self, key: K, value: V, ) -> &mut Self

Directly set a value (lowest-effort source, e.g. a default).

Source

pub fn load_file(&mut self, path: &str) -> Result<&mut Self>

Load and merge a config file, autodetecting the format by extension (.toml, .ini/.conf, .json). Values overwrite existing keys.

Source

pub fn load_file_opt(&mut self, path: &str) -> Result<&mut Self>

Try to load a file if it exists; missing files are not an error. Handy for “load ~/.config/tool.toml if present”.

Source

pub fn get(&self, key: &str) -> Option<String>

Resolve a key using precedence: environment (if a prefix is set) wins over the loaded file/default values.

Source

pub fn resolve(&self, key: &str, flag: Option<&str>, default: &str) -> String

Resolve with an explicit flag value taking top precedence. Pass the flag value the user supplied (or None); this returns the first of flag → env → file → default.

Source

pub fn get_as<T: FromStr>(&self, key: &str) -> Result<Option<T>>

Parse a resolved value into any type.

Source

pub fn keys(&self) -> impl Iterator<Item = &String>

All resolved keys (file/default layer only; env is overlaid at get).

Trait Implementations§

Source§

impl Clone for Config

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 Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Forget for Config

§

impl Freeze for Config

§

impl Move for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

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.