toml-scaffold 0.1.0

Generate commented TOML scaffolds from Rust structs and values
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

mod format;
mod schema;

use schemars::JsonSchema;
use serde::Serialize;
pub use toml_scaffold_macros::TomlScaffold;

/// Trait for generating TOML scaffolds from Rust structs
pub trait TomlScaffold: Serialize + JsonSchema {
    /// Generate a scaffold from an actual struct instance
    ///
    /// Returns an error if serialization fails
    fn to_scaffold(&self) -> Result<String, toml::ser::Error> {
        let value = toml::Value::try_from(&self)?;

        let schema = schemars::schema_for!(Self);
        let schema_info = schema::extract_schema_info(&schema, "");

        let result = format::format_with_comments(
            &value,
            &schema_info.comments,
            &schema_info.all_fields,
            &schema_info.optional_fields,
            "",
        );
        // Rule 14: Always end file with a single newline
        Ok(format!("{}\n", result.trim_end()))
    }
}