Skip to main content

Source

Enum Source 

Source
pub enum Source {
    Folder(PathBuf),
    File(PathBuf),
    String {
        format: FormatKind,
        content: String,
    },
    Value(Result<Value, String>),
}
Expand description

One config source. Sources merge in order — later overrides earlier.

Variants§

§

Folder(PathBuf)

§

File(PathBuf)

§

String

An in-code string; its format may be a built-in or a [CustomFormat] (no formats registration needed — the source names its parser directly).

Fields

§format: FormatKind
§content: String
§

Value(Result<Value, String>)

An in-code serde value (Source::value) — already converted to a Value, or the serialization error to report at load time.

Implementations§

Source§

impl Source

Source

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

Accepts anything path-like: &str, String, &Path, PathBuf.

Source

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

Accepts anything path-like: &str, String, &Path, PathBuf.

Source

pub fn string(format: impl Into<FormatKind>, content: impl Into<String>) -> Self

An in-code config string — the hook for overriding values manually. Takes a [Format] or a [CustomFormat].

Source

pub fn value(value: impl Serialize) -> Self

An in-code serde value — typed overrides without going through a format parser (works with any #[derive(Serialize)] type, no format feature needed). A serialization failure (e.g. a map with non-string keys) surfaces at load time; a Null root (e.g. None) contributes nothing, like every other source.

#[derive(serde::Serialize)]
struct Overrides {
    debug: bool,
}

let value: c4::Value = c4::Loader::new(c4::Options {
        sources: vec![c4::Source::value(Overrides { debug: true })],
        ..c4::Options::default()
    })
    .load()?;
assert_eq!(value["debug"].as_bool(), Some(true));

Trait Implementations§

Source§

impl Clone for Source

Source§

fn clone(&self) -> Source

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 Source

Source§

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

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

impl PartialEq for Source

Source§

fn eq(&self, other: &Source) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Source

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.