schematic 0.19.7

A layered serde configuration and schema library.
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

#![allow(dead_code)]

use schematic::*;
use std::collections::HashMap;

fn validate_string<T, C>(value: &str, _: &T, _: &C, _: bool) -> ValidateResult {
    if value == "FOO" {
        return Err(ValidateError::new("invalid string FOO"));
    }

    Ok(())
}

fn transform_string(value: String, _ctx: &()) -> TransformResult<String> {
    Ok(value.to_uppercase())
}

fn transform_number(value: usize, _ctx: &()) -> TransformResult<usize> {
    Ok(value * 2)
}

fn transform_vec(mut value: Vec<String>, _ctx: &()) -> TransformResult<Vec<String>> {
    value.push("item".into());
    Ok(value)
}

#[derive(Debug, Config, PartialEq)]
pub struct Transforms {
    #[setting(transform = transform_string, validate = validate_string)]
    string: String,
    #[setting(transform = transform_number)]
    number: usize,
    #[setting(transform = transform_vec)]
    vector: Vec<String>,
}

#[test]
fn transforms_values() {
    let result = ConfigLoader::<Transforms>::new()
        .code("string: abc", "code.yaml")
        .unwrap()
        .code("number: 123", "code.yaml")
        .unwrap()
        .load()
        .unwrap();

    assert_eq!(result.config.string, "ABC");
    assert_eq!(result.config.number, 246);
    assert_eq!(result.config.vector, vec!["item"]);
}

#[test]
fn errors_for_invalid_transformed_field() {
    let error = ConfigLoader::<Transforms>::new()
        .code("string: foo", "code.yaml")
        .unwrap()
        .load()
        .err()
        .unwrap();

    assert_eq!(
        error.to_full_string(),
        "Failed to validate Transforms. \n  string: invalid string FOO"
    )
}

#[derive(Debug, Config)]
pub struct TransformsOptional {
    #[setting(transform = transform_string)]
    string: Option<String>,
    #[setting(transform = transform_number)]
    number: Option<usize>,
    #[setting(transform = transform_vec)]
    vector: Option<Vec<String>>,
}

#[test]
fn transforms_optional_values() {
    let result = ConfigLoader::<TransformsOptional>::new()
        .code("string: abc", "code.yaml")
        .unwrap()
        .load()
        .unwrap();

    assert_eq!(result.config.string, Some("ABC".to_owned()));
    assert_eq!(result.config.number, None);
    assert_eq!(result.config.vector, None);
}

fn transform_nested_vec(
    mut value: Vec<PartialTransforms>,
    _ctx: &(),
) -> TransformResult<Vec<PartialTransforms>> {
    value.iter_mut().for_each(|v| {
        v.number = Some(1);
    });

    Ok(value)
}

fn transform_nested_map(
    value: HashMap<usize, PartialTransforms>,
    _ctx: &(),
) -> TransformResult<HashMap<usize, PartialTransforms>> {
    Ok(value)
}

#[derive(Debug, Config)]
pub struct TransformsNested {
    #[setting(nested, transform = transform_nested_vec)]
    list: Vec<Transforms>,
    #[setting(nested, transform = transform_nested_map)]
    map: HashMap<usize, Transforms>,
}

#[test]
fn transforms_nested_values() {
    let result = ConfigLoader::<TransformsNested>::new()
        .code(
            r#"
list:
  - string: xyz"#,
            "code.yaml",
        )
        .unwrap()
        .load()
        .unwrap();

    assert_eq!(
        result.config.list,
        vec![Transforms {
            string: "XYZ".to_owned(),
            number: 1,
            vector: vec!["item".to_owned()],
        }]
    );
}