Skip to main content

ConfigLoader

Struct ConfigLoader 

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

Loads typed configuration from ordered source adapters.

ConfigLoader::app() / ConfigLoader::new() keeps the service-oriented policy: defaults → TOML → profile dotenv → dotenv → adapter sources → env → overrides. ConfigLoader::toml(path) is deterministic file-only loading. ConfigLoader::custom() only loads explicitly provided sources.

Implementations§

Source§

impl ConfigLoader

Source

pub fn new() -> Self

Create an application/service loader.

Source

pub fn app() -> Self

Create an application/service loader.

Source

pub fn toml(path: impl Into<PathBuf>) -> Self

Create a deterministic single-TOML loader.

This policy does not read dotenv files or process environment variables.

Source

pub fn custom() -> Self

Create a loader with no implicit sources.

Source

pub fn with_default( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Set a programmatic default value.

Defaults are loaded before all configured sources.

Source

pub fn with_config_file(self, path: impl Into<PathBuf>) -> Self

Explicitly set the TOML config file path for app loading.

Source

pub fn with_env_file(self, path: impl Into<PathBuf>) -> Self

Explicitly set the .env file path for app loading.

Source

pub fn with_env_prefix(self, prefix: impl Into<String>) -> Self

Override the env-var prefix for app loading.

Separator is always "__".

Source

pub fn with_profile(self, profile: impl Into<String>) -> Self

Set the configuration profile for app loading.

Loads config/profiles/{profile}.env before the main .env file. If an empty string is passed, the profile name is read from the ENVIRONMENT environment variable during loading.

Source

pub fn with_source(self, source: impl ConfigSource) -> Self

Add an adapter source.

In app loading, adapter sources are evaluated after files/dotenv and before process environment variables. In custom/TOML loading, adapter sources are evaluated after the primary file and before overrides.

Source

pub fn with_override( self, key: impl Into<String>, value: impl Into<Value>, ) -> Self

Set a programmatic override value.

Overrides are loaded after all sources and have the highest precedence.

Source

pub fn load<T>(&self) -> AppResult<T>

Load any typed config from this loader’s source policy.

This path does not run validation; the type only needs to be Deserialize. Use ConfigLoader::load_validated to additionally run rskit_validation::Validate, or ConfigLoader::load_app for the service-application convenience.

Source

pub fn load_with<T>(&self, apply_defaults: impl FnOnce(&mut T)) -> AppResult<T>

Load any typed config and apply programmatic defaults (no validation).

Source

pub fn load_validated<T>(&self) -> AppResult<T>

Load a typed config and run rskit_validation::Validate after decoding.

Source

pub fn load_validated_with<T>( &self, apply_defaults: impl FnOnce(&mut T), ) -> AppResult<T>

Load a typed config, apply programmatic defaults, then run validation.

Source

pub fn load_app<T>(&self) -> AppResult<T>
where T: AppConfig,

Load an application/service config and call AppConfig::apply_defaults.

Applies defaults via AppConfig::apply_defaults, then runs validation.

Trait Implementations§

Source§

impl Debug for ConfigLoader

Source§

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

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

impl Default for ConfigLoader

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more