Struct Config 

pub struct Config {
    pub project: ProjectConfig,
    pub sync: SyncConfig,
    pub environments: BTreeMap<String, EnvironmentConfig>,
}

Main configuration file (rigg.yaml)

Fields

project: ProjectConfig

sync: SyncConfig

environments: BTreeMap<String, EnvironmentConfig>

Implementations

impl Config

pub const FILENAME: &'static str = "rigg.yaml"

Default configuration filename

pub fn files_root(&self, project_root: &Path) -> PathBuf

Root directory for resource files (search/, foundry/).

When project.files_path is set, returns project_root/files_path. Otherwise returns project_root itself.

pub fn load(dir: &Path) -> Result<Self, ConfigError>

Load configuration from a directory

pub fn load_from(path: &Path) -> Result<Self, ConfigError>

Load configuration from a specific file path

pub fn save(&self, dir: &Path) -> Result<(), ConfigError>

Save configuration to a directory

pub fn save_to(&self, path: &Path) -> Result<(), ConfigError>

Save configuration to a specific file path

pub fn validate(&self) -> Result<(), ConfigError>

Validate configuration

pub fn resolve_env( &self, name: Option<&str>, ) -> Result<ResolvedEnvironment, ConfigError>

Resolve an environment by name (or default)

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

Find the default environment name

pub fn environment_names(&self) -> Vec<&str>

Get all environment names

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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<'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 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.