peace_params 0.0.15

Constraints and specifications for parameters for the peace automation framework.
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

use crate::{FieldNameAndType, ValueResolutionCtx};

/// Failed to resolve values for a `Params` object from `resources`.
//
// TODO: Help text could be generated based on the type of `Params` -- named fields struct, tuple
// struct, enum -- instead of assuming it's always a named fields struct.
#[derive(Debug, thiserror::Error)]
#[cfg_attr(feature = "error_reporting", derive(miette::Diagnostic))]
pub enum ParamsResolveError {
    /// Failed to resolve a field value from `resources`.
    #[cfg_attr(
        feature = "error_reporting",
        diagnostic(
            code(peace_params::params_resolve_error::from),
            help("Make sure `{field_type_name}` has been inserted into `resources`.",
                field_type_name = value_resolution_ctx
                    .resolution_chain()
                    .last()
                    .map(FieldNameAndType::type_name)
                    .unwrap_or(value_resolution_ctx.params_type_name())
            )
        )
    )]
    #[error("Failed to resolve `{field_type_name}` to populate:\n\
        \n\
        ```rust\n\
        {value_resolution_ctx}\n\
        ```",
        field_type_name = value_resolution_ctx
            .resolution_chain()
            .last()
            .map(FieldNameAndType::type_name)
            .unwrap_or(value_resolution_ctx.params_type_name()))]
    InMemory {
        /// Hierarchy of fields traversed to resolve the value.
        value_resolution_ctx: ValueResolutionCtx,
    },

    /// Failed to borrow a field value from `resources`.
    #[cfg_attr(
        feature = "error_reporting",
        diagnostic(
            code(peace_params::params_resolve_error::from_borrow_conflict),
            help("By design `{field_type_name}` must not be borrowed mutably.",
                field_type_name = value_resolution_ctx
                    .resolution_chain()
                    .last()
                    .map(FieldNameAndType::type_name)
                    .unwrap_or(value_resolution_ctx.params_type_name())
            )
        )
    )]
    #[error("Borrow conflict on `{field_type_name}` to populate:\n\
        \n\
        ```rust\n\
        {value_resolution_ctx}\n\
        ```",
        field_type_name = value_resolution_ctx
            .resolution_chain()
            .last()
            .map(FieldNameAndType::type_name)
            .unwrap_or(value_resolution_ctx.params_type_name())
        )
    ]
    InMemoryBorrowConflict {
        /// Hierarchy of fields traversed to resolve the value.
        value_resolution_ctx: ValueResolutionCtx,
    },

    /// Failed to resolve a from value from `resources`.
    #[cfg_attr(
        feature = "error_reporting",
        diagnostic(
            code(peace_params::params_resolve_error::from_map),
            help(
                "Make sure `{from_type_name}` has been inserted into `resources`.\n\
                Value resolution mode is: {value_resolution_mode:?}",
                value_resolution_mode = value_resolution_ctx.value_resolution_mode()
            )
        )
    )]
    #[error(
        "Failed to resolve `{from_type_name}` to populate:\n\
        \n\
        ```rust\n\
        {value_resolution_ctx}\n\
        ```"
    )]
    FromMap {
        /// Hierarchy of fields traversed to resolve the value.
        value_resolution_ctx: ValueResolutionCtx,
        /// Name of the type from which to map the field value from.
        ///
        /// Corresponds to `U` in `Fn(&U) -> T`.
        from_type_name: String,
    },

    /// Failed to borrow a value to map to a field from `resources`.
    #[cfg_attr(
        feature = "error_reporting",
        diagnostic(
            code(peace_params::params_resolve_error::from_map_borrow_conflict),
            help("By design `{from_type_name}` must not be borrowed mutably.")
        )
    )]
    #[error(
        "Borrow conflict on `{from_type_name}` to populate:\n\
        \n\
        ```rust\n\
        {value_resolution_ctx}\n\
        ```"
    )]
    FromMapBorrowConflict {
        /// Hierarchy of fields traversed to resolve the value.
        value_resolution_ctx: ValueResolutionCtx,
        /// Name of the type from which to map the field value from.
        ///
        /// Corresponds to `U` in `Fn(&U) -> T`.
        from_type_name: String,
    },
}