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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
use crate::{error::OptionsError, format::Format, validation}; /// Options for serde support. #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum SerdeSupport { /// Do not derive any serde traits for the struct. No, /// Derive `Serialize` and `Deserialize` for the struct. Yes, /// Derive any combination of `Serialize` and `Deserialize` /// for the struct. Mixed { serialize: bool, deserialize: bool }, } impl SerdeSupport { pub(crate) fn should_derive_ser_de(self) -> Option<(bool, bool)> { match self { Self::No => None, Self::Yes => Some((true, true)), Self::Mixed { serialize, deserialize, } => { if !(serialize || deserialize) { None } else { Some((serialize, deserialize)) } } } } } impl Default for SerdeSupport { fn default() -> Self { Self::No } } /// When to perform dynamic loading from the config file itself. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum DynamicLoading { /// Always load the config from file. Always, /// Load from file in debug mode, but use the statically-included /// const in release mode. DebugOnly, /// Never load dynamically. Always use the statically-included /// const. Never, } impl Default for DynamicLoading { fn default() -> Self { Self::DebugOnly } } /// Represents a floating-point type. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum FloatSize { F32, F64, } /// Represents an integer type. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum IntSize { I8, I16, I32, I64, ISize, } /// Options for configuring the generation of a struct. #[derive(Debug, Clone, PartialEq, Eq)] pub struct StructOptions { /// The format of the source data. /// /// Defaults to `None` which will cause it to be inferred from the /// file type. pub format: Option<Format>, /// The name of the resulting struct. /// /// Defaults to `"Config"`. pub struct_name: String, /// The name of the resulting const, if generated. /// /// Defaults to the value of `struct_name` in uppercase. pub const_name: Option<String>, /// Whether or not to generate a `const` instance of the struct. /// /// Defaults to `true`. pub generate_const: bool, /// A list of traits for the struct to derive. /// /// Defaults to `["Debug", "Clone"]` /// /// (Note that the `serde_support` option below may add to this /// list.) pub derived_traits: Vec<String>, /// Shorthand for generating the Serialize and Deserialize traits. /// /// Defaults to `No`. pub serde_support: SerdeSupport, /// The recommended way to derive Serialize and Deserialize /// is via the `serde` crate's /// [`derive` feature](https://serde.rs/derive.html). /// /// If you instead need to use the old method of including the /// `serde_derive` crate, set this flag to `true`. pub use_serde_derive_crate: bool, /// Whether or not to generate helper functions to load the /// struct at runtime. /// /// Defaults to `true`. /// /// **Note:** These load functions depend on the `Deserialize` /// trait, as well as the relevant serde library for the config /// format. /// /// So for example, if you generate a struct from `config.json` /// then you will have to enable `serde_support` for the /// `Deserialize` trait, and you will also have to include the /// `serde_json` library in your crate. pub generate_load_fns: bool, /// Whether the load functions, if generated, are dynamic, /// and when. /// /// Defaults to `DebugOnly`. pub dynamic_loading: DynamicLoading, /// Whether or not to create the parent directories of the /// output file, if they don't exist. /// /// Defaults to `true`. pub create_dirs: bool, /// Whether to check if the destination file would be changed /// before writing output. /// /// This is to avoid unnecessary writes from marking the /// destination file as changed (which could, for example, /// trigger a process which is watching for changes). This /// option only works with the `create_*` functions. /// /// Defaults to `true`. pub write_only_if_changed: bool, /// The type of floating point values in the config, where the /// format does not make it explicit. /// /// Defaults to `F64`. pub default_float_size: FloatSize, /// The type of integer values in the config, where the /// format does not make it explicit. /// /// Defaults to `I64`. pub default_int_size: IntSize, /// The maximum array size, over which array values in the /// config will be represented as slices instead. /// /// If set to `0`, slices will always be used. /// /// Defaults to `0`. pub max_array_size: usize, } impl StructOptions { pub(crate) fn validate(&self) -> Result<(), OptionsError> { if !validation::valid_identifier(&self.struct_name) { return Err(OptionsError::InvalidStructName(self.struct_name.clone())); } Ok(()) } pub(crate) fn real_const_name(&self) -> String { self.const_name .clone() .unwrap_or_else(|| self.struct_name.to_uppercase()) } /// The default options plus serde support. This includes /// `Serialize`/`Deserialize` traits, plus helpers functions /// to load the config. /// /// ```rust /// use config_struct::{StructOptions, SerdeSupport}; /// /// let options = StructOptions::serde_default(); /// /// assert_eq!(options, StructOptions { /// serde_support: SerdeSupport::Yes, /// generate_load_fns: true, /// .. StructOptions::default() /// }); /// ``` pub fn serde_default() -> Self { StructOptions { serde_support: SerdeSupport::Yes, generate_load_fns: true, ..Self::default() } } } impl Default for StructOptions { /// ```rust /// use config_struct::*; /// /// let default_options = StructOptions { /// format: None, /// struct_name: "Config".to_owned(), /// const_name: None, /// generate_const: true, /// derived_traits: vec![ /// "Debug".to_owned(), /// "Clone".to_owned(), /// ], /// serde_support: SerdeSupport::No, /// use_serde_derive_crate: false, /// generate_load_fns: false, /// dynamic_loading: DynamicLoading::DebugOnly, /// create_dirs: true, /// write_only_if_changed: true, /// default_float_size: FloatSize::F64, /// default_int_size: IntSize::I64, /// max_array_size: 0, /// }; /// assert_eq!(default_options, StructOptions::default()); /// ``` fn default() -> Self { StructOptions { format: None, struct_name: "Config".to_owned(), const_name: None, generate_const: true, derived_traits: vec!["Debug".to_owned(), "Clone".to_owned()], serde_support: SerdeSupport::default(), use_serde_derive_crate: false, generate_load_fns: false, dynamic_loading: DynamicLoading::DebugOnly, create_dirs: true, write_only_if_changed: true, default_float_size: FloatSize::F64, default_int_size: IntSize::I64, max_array_size: 0, } } } /// Options for configuring the generation of a struct. #[derive(Debug, Clone, PartialEq, Eq)] pub struct EnumOptions { /// The format of the source data. /// /// Defaults to `None` which will cause it to be inferred from the /// file type. pub format: Option<Format>, /// The name of the resulting enum. /// /// Defaults to `"Key"`. pub enum_name: String, /// The name of the const slice containing all variants. /// For example, if you specify `Some("ALL")`, then /// `MyEnum::ALL` will contain all variants of the enum. /// /// If you specify `None` then no constant will be /// generated. /// /// Defaults to `Some("ALL")`. pub all_variants_const: Option<String>, /// A list of traits for the struct to derive. /// /// Defaults to `["Debug", "Clone", "Copy", "PartialEq", /// "Eq", "PartialOrd", "Ord", "Hash"]` /// /// (Note that the `serde_support` option below may add /// to this list.) pub derived_traits: Vec<String>, /// Whether to implement the `Default` trait for this enum. /// If `true` then the default value will be the first /// variant specified. /// /// Defaults to `true`. pub first_variant_is_default: bool, /// Whether to implement the `Display` trait for this enum. /// This requires the `Debug` trait to be implemented. /// /// Defaults to `true`. pub impl_display: bool, /// Whether to implement the `FromStr` trait for this enum. /// This requires the `all_variants_const` to be set to /// something other than `None`. /// /// Defaults to `true`. pub impl_from_str: bool, /// Shorthand for generating the Serialize and Deserialize /// traits. /// /// Defaults to `No`. pub serde_support: SerdeSupport, /// The recommended way to derive Serialize and Deserialize /// is via the `serde` crate's /// [`derive` feature](https://serde.rs/derive.html). /// /// If you instead need to use the old method of including /// the `serde_derive` crate, set this flag to `true`. pub use_serde_derive_crate: bool, /// Whether or not to create the parent directories of the /// output file, if they don't exist. /// /// Defaults to `true`. pub create_dirs: bool, /// Whether to check if the destination file would be changed /// before writing output. /// /// This is to avoid unnecessary writes from marking the /// destination file as changed (which could, for example, /// trigger a process which is watching for changes). This /// option only works with the `create_*` functions. /// /// Defaults to `true`. pub write_only_if_changed: bool, } impl EnumOptions { pub(crate) fn validate(&self) -> Result<(), OptionsError> { eprintln!("TODO: EnumOptions::validate"); Ok(()) } /// The default options plus serde support. This includes /// `Serialize`/`Deserialize` traits, plus helpers functions /// to load the config. /// /// ```rust /// use config_struct::{EnumOptions, SerdeSupport}; /// /// let options = EnumOptions::serde_default(); /// /// assert_eq!(options, EnumOptions { /// serde_support: SerdeSupport::Yes, /// .. EnumOptions::default() /// }); /// ``` pub fn serde_default() -> Self { EnumOptions { serde_support: SerdeSupport::Yes, ..Self::default() } } } /// Defaults to `["Debug", "Clone", "Copy", "PartialEq", /// "Eq", "PartialOrd", "Ord", "Hash"]` impl Default for EnumOptions { /// ```rust /// use config_struct::*; /// /// let default_options = EnumOptions { /// format: None, /// enum_name: "Key".to_owned(), /// all_variants_const: Some("ALL".to_owned()), /// derived_traits: vec![ /// "Debug".to_owned(), /// "Clone".to_owned(), /// "Copy".to_owned(), /// "PartialEq".to_owned(), /// "Eq".to_owned(), /// "PartialOrd".to_owned(), /// "Ord".to_owned(), /// "Hash".to_owned(), /// ], /// first_variant_is_default: true, /// impl_display: true, /// impl_from_str: true, /// serde_support: SerdeSupport::No, /// use_serde_derive_crate: false, /// create_dirs: true, /// write_only_if_changed: true, /// }; /// assert_eq!(default_options, EnumOptions::default()); /// ``` fn default() -> Self { EnumOptions { format: None, enum_name: "Key".to_owned(), all_variants_const: Some("ALL".to_owned()), derived_traits: vec![ "Debug".to_owned(), "Clone".to_owned(), "Copy".to_owned(), "PartialEq".to_owned(), "Eq".to_owned(), "PartialOrd".to_owned(), "Ord".to_owned(), "Hash".to_owned(), ], first_variant_is_default: true, impl_display: true, impl_from_str: true, serde_support: SerdeSupport::default(), use_serde_derive_crate: false, create_dirs: true, write_only_if_changed: true, } } }