Enum sea_orm_rocket::figment::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)

Tuple Fields

0: PathBuf

A file: the path to the file.

Code(&'static Location<'static>)

Tuple Fields

0: &'static Location<'static>

Some programatic value: the source location.

Custom(String)

Tuple Fields

0: 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

pub 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

pub 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.

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

Formats the value using the given formatter.

impl<'_> From<&'_ Path> for Source

pub fn from(path: &Path) -> Source

Performs the conversion.

impl<'_> From<&'_ str> for Source

pub fn from(string: &str) -> Source

Performs the conversion.

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

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

Performs the conversion.

impl From<String> for Source

pub fn from(string: String) -> Source

Performs the conversion.

impl PartialEq<Source> for Source

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Source