Struct pathfix::config::Config

pub struct Config {
    pub base: bool,
    pub include_administrative: Option<IncludeAdministrative>,
    pub paths: Paths,
    pub env: HashMap<String, String>,
}

Fields

base: bool

include_administrative: Option<IncludeAdministrative>

paths: Paths

env: HashMap<String, String>

Implementations

impl Config

pub fn new() -> Config

Creates a new Config

This should yield the same as Default::default()

Examples

use pathfix::config::Config;

assert_eq!(Config::new(), Default::default());

pub fn included() -> Config

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Config>

Read the config from a specific file.

Examples

use pathfix::config::Config;

let config = Config::from_file("src/config.toml").unwrap();
println!("{:?}", config);

pub fn with_env(self) -> Config

Sets the env parameter with the system environment.

All existing variables in the config will be overwritten. Use Config::merge if you want to add them to existing environment variables in a Config.

Examples

use std::env;
use pathfix::config::Config;

env::set_var("FOO", "BAR");
let config = Config::new().with_env();
assert_eq!(config.env["FOO"], "BAR");

pub fn merge(self, other: Config) -> Config

Merges two Config structures. Changes in the other Config will overwrite vaules in self.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq<Config> for Config

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

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

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

This method tests for !=.

impl Serialize for Config

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Config

impl StructuralPartialEq for Config