Skip to main content

Loader

Struct Loader 

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

Service for loading configuration from sources.

The Loader is responsible for:

  • Loading raw content from sources
  • Detecting and parsing formats
  • Converting to typed configuration

Implementations§

Source§

impl Loader

Source

pub fn new() -> Self

Create a new Loader with default options.

Source

pub fn builder() -> LoaderBuilder

Create a builder for constructing a Loader.

Source

pub fn options(&self) -> &LoadOptions

Get the load options.

Source

pub fn load_raw<S: Source>(&self, source: &S) -> Result<RawContent>

Load raw content from a source.

§Errors

Returns an error if the source cannot be read.

Source

pub fn load<S: Source>(&self, source: &S) -> Result<ParsedContent>

Load and parse content from a source.

§Errors

Returns an error if loading or parsing fails.

Source

pub fn load_as<S: Source, T: DeserializeOwned>(&self, source: &S) -> Result<T>

Load and parse content from a source into a specific type.

§Errors

Returns an error if loading, parsing, or deserialization fails.

Source

pub fn parse(&self, raw: &RawContent, format: Format) -> Result<ParsedContent>

Parse raw content using a specific format.

§Errors

Returns an error if parsing fails.

Source

pub fn parse_raw( &self, raw: RawContent, detected_format: Option<Format>, ) -> Result<ParsedContent>

Parse raw content, detecting the format.

§Errors

Returns an error if parsing fails or format cannot be detected.

Source

pub fn merge(&self, contents: Vec<ParsedContent>) -> ParsedContent

Merge multiple parsed contents.

Uses the merge strategy from options.

Source

pub fn to_type<T: DeserializeOwned>(&self, content: ParsedContent) -> Result<T>

Convert parsed content to a specific type.

§Errors

Returns an error if deserialization fails.

Source

pub fn load_multiple<S: Source>(&self, sources: &[S]) -> Result<ParsedContent>

Load from multiple sources and merge.

Sources are loaded in order and merged according to the merge strategy. Optional sources that fail are skipped if ignore_optional_missing is true.

§Errors

Returns an error if a required source fails and fail_fast is true.

Trait Implementations§

Source§

impl Clone for Loader

Source§

fn clone(&self) -> Loader

Returns a duplicate of the value. Read more
1.0.0 · 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 = 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.