Skip to main content

ConfigLoader

Struct ConfigLoader 

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

Builder for a layered config load.

Sources are applied in the order they were registered. The typical JSS-parity invocation is:

use solid_pod_rs::config::ConfigLoader;

let cfg = ConfigLoader::new()
    .with_defaults()
    .with_file("config.json")
    .with_env()
    .load()
    .await?;

Implementations§

Source§

impl ConfigLoader

Source

pub fn new() -> Self

Empty loader — add sources explicitly. Prefer Self::with_defaults as the first call so the final snapshot is always fully populated.

Source

pub fn with_defaults(self) -> Self

Register the hard-coded defaults as the lowest-precedence layer. Idempotent — calling twice has no additional effect.

Source

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

Register a config file source. Format is auto-detected from the extension: .json (always supported), .yaml/.yml, .toml (requires the config-loader feature). Missing / malformed files are a hard error at load time.

Source

pub fn with_env(self) -> Self

Register the process environment as a source. Reads JSS_* vars via std::env::var.

Source

pub fn with_env_overlay(&mut self) -> &mut Self

Builder alias matching Sprint 11 naming — mutates the loader in-place and returns &mut Self so operator scripts can chain overlays without rebinding. Equivalent to Self::with_env on a mutable loader.

Source

pub fn with_cli_overlay(&mut self, args: &CliArgs) -> &mut Self

Register a CLI args overlay as the highest-precedence layer.

Precedence: Defaults < File < Env < CLI.

The binary crate (clap) is the canonical caller; passing CliArgs::default() is a no-op overlay (every field None).

Source

pub fn from_file<P: AsRef<Path>>( path: P, ) -> impl Future<Output = Result<ServerConfig, PodError>>

Load a config snapshot directly from a single file path, bypassing the builder. Format auto-detected from extension. This is the Sprint 11 row 120 one-shot helper — equivalent to ConfigLoader::new().with_defaults().with_file(path).load().

Source

pub async fn load(self) -> Result<ServerConfig, PodError>

Resolve all sources in order, merge them, deserialise, and validate.

async for symmetry with JSS’s loadConfig and to leave room for an eventual remote-config source (e.g. Consul, Vault) without another breaking change. No await points today.

Source

pub fn warnings(&self) -> &[String]

Accessor for emitted warnings. Populated as a side-effect of Self::load if it is called; empty otherwise. Provided so test code can assert on warning behaviour without relying on a tracing subscriber.

Trait Implementations§

Source§

impl Clone for ConfigLoader

Source§

fn clone(&self) -> ConfigLoader

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 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> 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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