optify 1.3.2

Simplifies getting the right configuration options for a process using pre-loaded configurations from files (JSON, YAML, etc.) to manage options for experiments or flights. This library is mainly made to support building implementations for other languages such as Node.js, Python, and Ruby. It is not meant to be consumed directly yet.
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

// Similar to https://github.com/juharris/dotnet-OptionsProvider/blob/main/src/OptionsProvider/OptionsProvider/OptionsMetadata.cs

use serde::{Deserialize, Serialize};

type Details = serde_json::Value;

/// Information about a group of options.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[allow(unused)]
pub struct OptionsMetadata {
    // TODO Add more props.
    /// Alternative names for the group of options.
    ///
    /// This is helpful for using custom short names for the group of options.
    pub aliases: Option<Vec<String>>,

    /// The canonical names of features that import this one.
    pub dependents: Option<Vec<String>>,

    /// Other metadata that may be custom and application specific.
    ///
    /// This is a good place for documentation that should be available to the application.
    /// Comments that are not parsed are still great to have in files, when supported,
    /// but some comments are useful to have here because they can be accessed programmatically.
    pub details: Option<Details>,

    /// The name of the group of options.
    ///
    /// This may be derived from the file name including subdirectories.
    /// Should never be <tt>None</tt> or an empty string.
    /// When loading the options from a file, the name is automatically derived from the file name.
    pub name: Option<String>,

    /// The creators or maintainers of this group of options.
    ///
    /// For example, emails separated by ";".
    pub owners: Option<String>,

    /// The path to the file that contains the options.
    pub path: Option<String>,
}

impl OptionsMetadata {
    pub fn new(
        aliases: Option<Vec<String>>,
        details: Option<Details>,
        dependents: Option<Vec<String>>,
        name: Option<String>,
        owners: Option<String>,
        path: Option<String>,
    ) -> Self {
        Self {
            aliases,
            details,
            dependents,
            name,
            owners,
            path,
        }
    }
}