Struct Config 

pub struct Config {
    pub asbuilt: Option<String>,
    pub output: OutputConfig,
    pub docs: DocsConfig,
    pub theme: BTreeMap<String, ThemeColor>,
    pub externals: Vec<External>,
    pub sections: BTreeMap<String, Value>,
    pub path: Option<PathBuf>,
}

The parsed asbuilt.toml.

Other top-level entries stay in sections, where a front-end’s table ([rust], say) waits to be deserialized with that front-end’s schema; Config::check_tables rejects any that names no front-end. Unknown keys inside [output] or an [[externals]] entry are rejected when parsing.

use asbuilt_core::Config;

let config: Config = r#"
[output]
path = "arch/model.c4"

[rust]
include_tests = false
"#
.parse()
.unwrap();

assert_eq!(config.output.path, "arch/model.c4");
assert!(config.sections.contains_key("rust"));

Fields

asbuilt: Option<String>

The asbuilt release this config and its model are written for, as cargo install --version takes it. Config::load_for checks it against the running release before reading anything else; None runs under any release.

output: OutputConfig

docs: DocsConfig

theme: BTreeMap<String, ThemeColor>

[theme]: a color per element kind (container, component, bin, tests, examples, or an external kind), emitted as LikeC4 element styles so the diagrams come out in the consumer’s palette.

externals: Vec<External>

sections: BTreeMap<String, Value>

path: Option<PathBuf>

Where this config was read from, for error messages. None for a config parsed from a string or defaulted.

Implementations

impl Config

pub fn light_theme(&self) -> BTreeMap<String, String>

The light color per themed kind, the emitter’s input.

impl Config

pub fn load(root: &Path) -> Result<Self>

The config at root/asbuilt.toml, or the defaults when there is no such file.

pub fn load_file(path: &Path) -> Result<Self>

A config from an explicit path (--config); a missing file is an error here, unlike Config::load.

pub fn load_for( root: &Path, config_path: Option<&Path>, running: &str, ) -> Result<Self>

The config a binary at release running reads: config_path when given, else root/asbuilt.toml, else the defaults. The pin is checked against running before the rest of the file is deserialized, so a config written for another release fails on the version, not on a table or key this release does not know.

pub fn file_path(&self) -> PathBuf

The file this config came from, for error messages: asbuilt.toml when it was parsed from a string or defaulted.

pub fn check_tables(&self, frontends: &[&str]) -> Result<()>

Every top-level entry is asbuilt’s own or the table of one of frontends (by Frontend::name); the first that is neither is an error naming it as written.

pub fn section<T: DeserializeOwned>(&self, name: &str) -> Result<Option<T>>

A front-end’s own table, deserialized with its schema. Ok(None) when the table is absent; a Config error naming the file when it is present and does not fit.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

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 Default for Config

fn default() -> Self

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 FromStr for Config

Parsing alone: the pin’s place and shape are checked by the loaders, which know the file to name.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Config