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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
//! This crate is a library for generating structs and enums based on a config //! file at build time. It is intended for use in a `build.rs` file //! so should be included in your `[build-dependencies]`. //! //! ```toml //! [build-dependencies.config_struct] //! version = "~0.4.0" //! features = ["toml-parsing"] //! ``` //! //! By default, `config_struct` is markup-language-agnostic, so //! include the relevant feature for whatever language your config //! file is written in. Choices are: //! //! 1. `json-parsing` //! 2. `ron-parsing` //! 3. `toml-parsing` //! 4. `yaml-parsing` //! //! Only `toml-parsing` is included by default, so be sure to specify //! the features you need in your `Cargo.toml` file. //! //! # Examples //! //! ## Structs //! //! ```rust,no_run //! // build.rs //! use config_struct::{Error, StructOptions}; //! //! fn main() -> Result<(), Error> { //! config_struct::create_struct( //! "config.toml", //! "src/config.rs", //! &StructOptions::default()) //! } //! ``` //! //! The above build script will take the following `config.toml` file and generate //! a `config.rs` like the following: //! //! ```toml //! # config.toml //! name = "Application" //! version = 5 //! features = [ //! "one", //! "two", //! "three" //! ] //! ``` //! //! ```rust,no_run //! // config.rs //! // ... //! use std::borrow::Cow; //! //! #[derive(Debug, Clone)] //! #[allow(non_camel_case_types)] //! pub struct Config { //! pub features: Cow<'static, [Cow<'static, str>]>, //! pub name: Cow<'static, str>, //! pub version: i64, //! } //! //! pub const CONFIG: Config = Config { //! features: Cow::Borrowed(&[Cow::Borrowed("one"), Cow::Borrowed("two"), Cow::Borrowed("three")]), //! name: Cow::Borrowed("Application"), //! version: 5, //! }; //! ``` //! //! Strings and arrays are represented by `Cow` types, which allows //! the entire Config struct to be either heap allocated at runtime, //! or a compile time constant, as shown above. //! //! ## Enums //! //! ```rust,no_run //! // build.rs //! use config_struct::{Error, EnumOptions}; //! //! fn main() -> Result<(), Error> { //! config_struct::create_enum( //! "items.yaml", //! "src/items.rs", //! &EnumOptions::default()) //! } //! ``` //! //! The above build script will take the following `items.yaml` file and generate //! a (not-formatted) `items.rs` like the following: //! //! ```yaml //! # items.yaml //! ItemOne: //! - data //! ItemTwo: //! - more //! - data //! ``` //! //! ```rust,no_run //! // items.rs //! // ... //! #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] //! pub enum Key { //! ItemOne, //! ItemTwo, //! } //! impl Key { //! pub const ALL: &'static [Key] = &[Key::ItemOne, Key::ItemTwo]; //! } //! impl Default for Key { //! fn default() -> Self { //! Self::ItemOne //! } //! } //! impl std::fmt::Display for Key { //! fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { //! write!(f, "{:?}", self) //! } //! } //! impl std::str::FromStr for Key { //! type Err = (); //! fn from_str(s: &str) -> Result<Self, Self::Err> { //! const STRINGS: &'static [&'static str] = &["ItemOne", "ItemTwo"]; //! for (index, &key) in STRINGS.iter().enumerate() { //! if key == s { //! return Ok(Key::ALL[index]); //! } //! } //! Err(()) //! } //! } //! ``` //! //! As you can see, this provides more functionality out-of-the-box - most of //! which could be disabled in the `EnumOptions`. The intended purpose of //! this is to have a small efficient type to use as a key into the data stored //! in the initial config file. #[cfg(feature = "json-parsing")] mod json_parsing; #[cfg(feature = "ron-parsing")] mod ron_parsing; #[cfg(feature = "toml-parsing")] mod toml_parsing; #[cfg(feature = "yaml-parsing")] mod yaml_parsing; mod enums; mod structs; mod error; mod files; mod format; mod generation; mod load_fns; mod options; mod parsing; mod validation; mod value; #[cfg(not(any( feature = "json-parsing", feature = "ron-parsing", feature = "toml-parsing", feature = "yaml-parsing" )))] compile_error!("The config_struct crate requires at least one parsing feature to be enabled:\n {json-parsing, ron-parsing, toml-parsing, yaml-parsing}"); pub use crate::{ enums::*, error::{Error, GenerationError, OptionsError}, format::Format, options::{DynamicLoading, FloatSize, IntSize, SerdeSupport, StructOptions, EnumOptions}, structs::*, };