optify 1.3.1

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
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

use std::path::Path;

use serde_json::Value;

use crate::builder::builder_options::BuilderOptions;

use crate::{
    provider::{CacheOptions, Features, GetOptionsPreferences},
    schema::metadata::OptionsMetadata,
};

/// Trait defining the core functionality for an options provider
pub trait OptionsRegistry {
    fn build(directory: impl AsRef<Path>) -> Result<Self, String>
    where
        Self: Sized;

    fn build_from_directories(directories: &[impl AsRef<Path>]) -> Result<Self, String>
    where
        Self: Sized;

    fn build_from_directories_with_options(
        directories: &[impl AsRef<Path>],
        options: BuilderOptions,
    ) -> Result<Self, String>
    where
        Self: Sized;

    fn build_from_directories_with_schema(
        directories: &[impl AsRef<Path>],
        schema_path: impl AsRef<Path>,
    ) -> Result<Self, String>
    where
        Self: Sized,
    {
        let options = BuilderOptions {
            schema_path: Some(schema_path.as_ref().to_path_buf()),
            ..BuilderOptions::default()
        };
        Self::build_from_directories_with_options(directories, options)
    }

    fn build_with_options(
        directory: impl AsRef<Path>,
        options: BuilderOptions,
    ) -> Result<Self, String>
    where
        Self: Sized;

    fn build_with_schema(
        directory: impl AsRef<Path>,
        schema_path: impl AsRef<Path>,
    ) -> Result<Self, String>
    where
        Self: Sized,
    {
        let options = BuilderOptions {
            schema_path: Some(schema_path.as_ref().to_path_buf()),
            ..BuilderOptions::default()
        };
        Self::build_with_options(directory, options)
    }

    /// Gets all alias names.
    fn get_aliases(&self) -> Vec<String>;

    /// Gets all feature names and alias names.
    fn get_features_and_aliases(&self) -> Vec<String>;

    /// Gets all options for the specified feature names.
    fn get_all_options(
        &self,
        feature_names: &[impl AsRef<str>],
        cache_options: Option<&CacheOptions>,
        preferences: Option<&GetOptionsPreferences>,
    ) -> Result<Value, String>;

    /// Map an alias or canonical feature name (perhaps derived from a file name) to a canonical feature name.
    /// Canonical feature names map to themselves.
    ///
    /// Returns the canonical feature name.
    fn get_canonical_feature_name(&self, feature_name: &str) -> Result<String, String>;

    /// Map aliases or canonical feature names (perhaps derived from a file names) to the canonical feature names.
    /// Canonical feature names map to themselves.
    ///
    /// Returns the canonical feature names.
    fn get_canonical_feature_names(
        &self,
        feature_names: &[impl AsRef<str>],
    ) -> Result<Vec<String>, String>;

    fn get_feature_metadata(&self, canonical_feature_name: &str) -> Option<OptionsMetadata>;

    /// Returns all of the canonical feature names.
    fn get_features(&self) -> Vec<String>;

    /// Returns a list of canonical feature names that reference the given relative file path via ConfigurableString.
    fn get_features_referencing_file(&self, relative_path: &str) -> Option<Vec<String>>;

    /// Returns a map of all the canonical feature names to their metadata.
    fn get_features_with_metadata(&self) -> Features;

    /// Filters `feature_names` based on the preferences,
    /// such as the `preferences.constraints`.
    /// Also converts the feature names to canonical feature names if `preferences.skip_feature_name_conversion` is `false`.
    fn get_filtered_feature_names(
        &self,
        feature_names: &[impl AsRef<str>],
        preferences: Option<&GetOptionsPreferences>,
    ) -> Result<Vec<String>, String>;

    /// Gets options for a specific key and feature names
    fn get_options(&self, key: &str, feature_names: &[impl AsRef<str>]) -> Result<Value, String>;

    /// Gets options with preferences for a specific key and feature names
    fn get_options_with_preferences(
        &self,
        key: &str,
        feature_names: &[impl AsRef<str>],
        cache_options: Option<&CacheOptions>,
        preferences: Option<&GetOptionsPreferences>,
    ) -> Result<Value, String>;

    /// Indicates if the feature has conditions.
    fn has_conditions(&self, canonical_feature_name: &str) -> bool;

    /// Filters `feature_names` based on the preferences,
    /// such as the `preferences.constraints`.
    /// Returns a Vec of optional strings matching the input order.
    /// `None` means the feature was filtered out.
    /// `Some(canonical_name)` means the feature was kept.
    /// Also converts the feature names to canonical feature names if `preferences.skip_feature_name_conversion` is `false`.
    fn map_feature_names(
        &self,
        feature_names: &[impl AsRef<str>],
        preferences: Option<&GetOptionsPreferences>,
    ) -> Result<Vec<Option<String>>, String>;
}