rust-config-tree 0.1.9

Recursive include tree utilities for layered configuration files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Format inference and renderer option presets.
//!
//! Runtime loading and template rendering both use [`ConfigFormat`] so unknown
//! or extensionless files consistently fall back to YAML. The private option
//! helpers keep generated templates comment-rich and visually aligned across
//! YAML, TOML, and JSON5.

use std::{ffi::OsStr, path::Path};

/// File format used when loading config files or rendering templates.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConfigFormat {
    /// YAML format, selected for `.yaml`, `.yml`, unknown extensions, and paths
    /// without an extension.
    Yaml,
    /// TOML format, selected for `.toml`.
    Toml,
    /// JSON5-compatible format, selected for `.json` and `.json5`.
    Json,
}

/// Path-based format inference for config files and generated templates.
impl ConfigFormat {
    /// Infers the config format from a path extension.
    ///
    /// Unknown extensions intentionally fall back to YAML.
    ///
    /// # Arguments
    ///
    /// - `path`: Config or template path whose extension should be inspected.
    ///
    /// # Returns
    ///
    /// Returns the inferred [`ConfigFormat`].
    ///
    /// # Examples
    ///
    /// ```
    /// use rust_config_tree::ConfigFormat;
    ///
    /// assert_eq!(ConfigFormat::from_path("config.toml"), ConfigFormat::Toml);
    /// assert_eq!(ConfigFormat::from_path("config.json5"), ConfigFormat::Json);
    /// assert_eq!(ConfigFormat::from_path("config.unknown"), ConfigFormat::Yaml);
    /// ```
    pub fn from_path(path: impl AsRef<Path>) -> Self {
        match path.as_ref().extension().and_then(OsStr::to_str) {
            Some("toml") => Self::Toml,
            Some("json" | "json5") => Self::Json,
            Some("yaml" | "yml") | Some(_) | None => Self::Yaml,
        }
    }
}

/// Builds the YAML renderer options used by default templates.
///
/// # Arguments
///
/// This function has no arguments.
///
/// # Returns
///
/// Returns YAML format options shared by generated templates.
///
/// # Examples
///
/// ```no_run
/// let _ = ();
/// ```
pub(crate) fn yaml_options() -> confique::yaml::FormatOptions {
    let mut options = confique::yaml::FormatOptions::default();
    options.indent = 2;
    options.general.comments = true;
    options.general.env_keys = true;
    options.general.nested_field_gap = 1;
    options
}

/// Builds the TOML renderer options used by default templates.
///
/// # Arguments
///
/// This function has no arguments.
///
/// # Returns
///
/// Returns TOML format options shared by generated templates.
///
/// # Examples
///
/// ```no_run
/// let _ = ();
/// ```
pub(crate) fn toml_options() -> confique::toml::FormatOptions {
    let mut options = confique::toml::FormatOptions::default();
    options.general.comments = true;
    options.general.env_keys = true;
    options.general.nested_field_gap = 1;
    options
}

/// Builds the JSON5 renderer options used by default templates.
///
/// # Arguments
///
/// This function has no arguments.
///
/// # Returns
///
/// Returns JSON5 format options shared by generated templates.
///
/// # Examples
///
/// ```no_run
/// let _ = ();
/// ```
pub(crate) fn json5_options() -> confique::json5::FormatOptions {
    let mut options = confique::json5::FormatOptions::default();
    options.indent = 2;
    options.general.comments = true;
    options.general.env_keys = true;
    options.general.nested_field_gap = 1;
    options
}