Struct SourceConfig 

pub struct SourceConfig {
    pub name: String,
    pub optional: bool,
    pub priority: i32,
    pub cache: bool,
    pub format: Option<String>,
    pub path: Option<PathBuf>,
    pub url: Option<String>,
    pub env_prefix: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Configuration for a single source.

Describes how to load configuration from a specific source.

Fields

name: String

Name/identifier for this source.

optional: bool

Whether this source is optional.

priority: i32

Priority for this source (higher = more important).

cache: bool

Whether to cache the loaded content.

format: Option<String>

Format override (auto-detected if None).

path: Option<PathBuf>

Source-specific path (for file sources).

url: Option<String>

Source-specific URL for custom URL-backed sources.

env_prefix: Option<String>

Source-specific environment variable prefix.

extra: BTreeMap<String, String>

Additional source-specific options.

Implementations

impl SourceConfig

pub fn new(name: impl Into<String>) -> Self

Create a new source config with the given name.

pub fn builder() -> SourceConfigBuilder

Create a builder for constructing a SourceConfig.

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

Create a file source config.

pub fn env(prefix: impl Into<String>) -> Self

Create an environment source config.

pub const fn is_optional(&self) -> bool

Check if this is an optional source.

pub fn display_id(&self) -> String

Get the display identifier for this source.

Trait Implementations

impl Clone for SourceConfig

fn clone(&self) -> SourceConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceConfig

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

Formats the value using the given formatter.

impl Default for SourceConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SourceConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceConfig

impl StructuralPartialEq for SourceConfig