Enum Source

#[non_exhaustive]
pub enum Source {
    File(PathBuf),
    Code(&'static Location<'static>),
    Custom(String),
}

The source for a configuration value.

The Source of a given value can be determined via that value’s Metadata.source retrievable via the value’s Tag (via Value::tag() or via the magic value Tagged) and Figment::get_metadata().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

File(PathBuf)

A file: the path to the file.

Code(&'static Location<'static>)

Some programatic value: the source location.

Custom(String)

A custom source all-together.

Implementations

impl Source

pub fn file_path(&self) -> Option<&Path>

Returns the path to the source file if self.kind is Kind::File.

Example

use std::path::Path;
use figment::Source;

let source = Source::from(Path::new("a/b/c.txt"));
assert_eq!(source.file_path(), Some(Path::new("a/b/c.txt")));

pub fn code_location(&self) -> Option<&'static Location<'static>>

Returns the location to the source code if self is Source::Code.

Example

use std::panic::Location;

use figment::Source;

let location = Location::caller();
let source = Source::Code(location);
assert_eq!(source.code_location(), Some(location));

pub fn custom(&self) -> Option<&str>

Returns the custom source location if self is Source::Custom.

Example

use figment::Source;

let source = Source::Custom("ftp://foo".into());
assert_eq!(source.custom(), Some("ftp://foo"));

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy 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

Displays the source. Location and custom sources are displayed directly. File paths are displayed relative to the current working directory if the relative path is shorter than the complete path.

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

Formats the value using the given formatter.

impl From<&'static Location<'static>> for Source

fn from(location: &'static Location<'static>) -> Source

Converts to this type from the input type.

impl From<&Path> for Source

fn from(path: &Path) -> Source

Converts to this type from the input type.

impl From<&str> for Source

fn from(string: &str) -> Source

Converts to this type from the input type.

impl From<String> for Source

fn from(string: String) -> Source

Converts to this type from the input type.

impl PartialEq for Source

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