Struct Source 

pub struct Source { /* private fields */ }

One configuration source declaration.

A Source holds a loader name, its options, and an optional resource address, as parsed from the SOURCE[(OPTIONS)][:RESOURCE] string format. See the crate-level documentation for the full format, parsing rules, and examples.

Examples

use tanzim_source::Source;

let source = Source::parse("env(prefix=APP_)")?;
assert_eq!(source.source(), "env");
assert_eq!(
    source.options().get("prefix").unwrap().as_string().unwrap(),
    "APP_"
);
assert_eq!(source.resource(), "");
assert_eq!(source.to_string(), "env(prefix=APP_)");

let file = Source::parse("file:app.toml")?;
assert_eq!(file.source(), "file");
assert_eq!(file.resource(), "app.toml");

Implementations

impl Source

pub fn parse(input: &str) -> Result<Source, ParseError>

Parse a SOURCE[(OPTIONS)][:RESOURCE] string into a Source.

Equivalent to the free function parse. See the crate-level documentation for the format and rules.

pub fn named(name: impl Into<String>) -> Source

Build a bare source with just a name — no options, no resource — infallibly.

Used for synthetic origins (e.g. tanzim_value::Locations that do not come from parsing a real source string). Unlike Source::parse this performs no validation, so the name may even be empty for a placeholder origin.

pub fn on_error(&self, stage: Stage) -> OnError

The error policy this source declares for stage, via its reserved on_error option.

Defaults to OnError::Fail when the option is absent, malformed, or does not mention the stage. on_error=(load=skip,validate=skip) yields OnError::Skip for those two stages.

pub fn source(&self) -> &str

The loader name (e.g. env, file, http).

pub fn source_mut(&mut self) -> &mut String

A mutable reference to the loader name.

pub fn set_source(&mut self, source: impl Into<String>)

Set the loader name.

pub fn with_source(self, source: impl Into<String>) -> Source

Set the loader name, builder-style.

pub fn options(&self) -> &Options

The loader options.

pub fn options_mut(&mut self) -> &mut Options

A mutable reference to the loader options.

pub fn set_options(&mut self, options: Options)

Replace the loader options.

pub fn with_options(self, options: Options) -> Source

Replace the loader options, builder-style.

pub fn set_option<K, V>(&mut self, key: K, value: V)

where K: Into<String>, V: Into<OptionValue>,

Set a single loader option.

pub fn with_option<K, V>(self, key: K, value: V) -> Source

where K: Into<String>, V: Into<OptionValue>,

Set a single loader option, builder-style.

pub fn resource(&self) -> &str

The resource address (path, URL, …), or empty if none was given.

pub fn resource_mut(&mut self) -> &mut String

A mutable reference to the resource address.

pub fn set_resource(&mut self, resource: impl Into<String>)

Set the resource address; a non-empty value also sets Source::resource_colon.

pub fn with_resource(self, resource: impl Into<String>) -> Source

Set the resource address, builder-style; a non-empty value also sets Source::resource_colon.

pub fn resource_colon(&self) -> bool

true if the source string had a : separator before the resource, even when the resource itself is empty (e.g. file:).

pub fn set_resource_colon(&mut self, resource_colon: bool)

Set whether the : separator is present before the resource.

pub fn with_resource_colon(self, resource_colon: bool) -> Source

Set whether the : separator is present before the resource, builder-style.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl Display for Source

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

Formats the value using the given formatter.

impl FromStr for Source

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Source, <Source as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Source

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Source

impl TryFrom<&String> for Source

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( value: &String, ) -> Result<Source, <Source as TryFrom<&String>>::Error>

Performs the conversion.

impl TryFrom<&str> for Source

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Source, <Source as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Cow<'_, str>> for Source

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( value: Cow<'_, str>, ) -> Result<Source, <Source as TryFrom<Cow<'_, str>>>::Error>

Performs the conversion.

impl TryFrom<String> for Source

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Source, <Source as TryFrom<String>>::Error>

Performs the conversion.