Struct SourceMetadata 

pub struct SourceMetadata {
    pub name: String,
    pub path: Option<PathBuf>,
    pub url: Option<String>,
    pub env_var: Option<String>,
    pub priority: i32,
    pub optional: bool,
    pub labels: Vec<String>,
}

Metadata about a configuration source.

Contains identifying information and optional attributes. URL metadata is available for custom user-defined sources; this crate does not ship a built-in HTTP source.

Fields

name: String

Unique identifier for this source.

path: Option<PathBuf>

Optional path (for file sources).

url: Option<String>

Optional URL (for remote sources).

env_var: Option<String>

Optional environment variable name.

priority: i32

Optional priority (higher = more important).

optional: bool

Whether this source is optional.

labels: Vec<String>

Source-specific labels/tags.

Implementations

impl SourceMetadata

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

Create new metadata with a name.

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

Set the path.

pub fn with_url(self, url: impl Into<String>) -> Self

Set the URL.

pub fn with_env_var(self, env_var: impl Into<String>) -> Self

Set the environment variable name.

pub const fn with_priority(self, priority: i32) -> Self

Set the priority.

pub const fn with_optional(self, optional: bool) -> Self

Set whether this source is optional.

pub fn with_label(self, label: impl Into<String>) -> Self

Add a label.

pub fn display_id(&self) -> String

Get display identifier for this source.

Trait Implementations

impl Clone for SourceMetadata

fn clone(&self) -> SourceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMetadata

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

Formats the value using the given formatter.

impl Default for SourceMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceMetadata

fn eq(&self, other: &SourceMetadata) -> 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 SourceMetadata

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 SourceMetadata

impl StructuralPartialEq for SourceMetadata