Struct a_cli_tool::config4::Config

pub struct Config {
    name: String,
    version: Version,
    description: Option<String>,
    data: AppData,
}

Config Reference

Config file reference for a_cli_tool.

By default a_cli_tool looks for configuration in ./config.yaml, unless another path is specified with the -c/--config parameter.

Config details the structure of the configuration.

NOTE: Field names will appear in YAML as they appear here, unless otherwise specified in the accompanying description.

Fields

name: String

The name of the thing this CLI tool is building for you.

version: Version

The version of the thing this CLI tool will build for you.

This is a SemVer version, e.g:

version: 1.2.3

description: Option<String>

Optional: A description of the thing this CLI tool is building for you.

data: AppData

Application config fields.

NOTE: These fields are included alongside the fields above, e.g:

name: foo
version: 1.2.3
source: # AppData fields
  file: path/to/file.yaml
target: path/to/target.yaml
actions: [ foo, bar ] # End of AppData fields

Trait Implementations

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.