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

#![cfg_attr(coverage_nightly, feature(coverage_attribute))]

//! Constraints and specifications for parameters for the peace automation
//! framework.
//!
//! This crate defines types and traits for implementors and users to work with
//! item params.
//!
//! # Design
//!
//! When an item is defined, implementors define the parameters type for
//! that item.
//!
//! For Peace to derive additional functionality from that type, this crate:
//!
//! * Defines the `Params` trait to bridge between the parameters type and
//!   associated types.
//! * Re-exports the `Params` derive macro which implements the `Params` trait.
//!
//! ## How It Fits Together
//!
//! ```text
//! .----------------------------------------------------------------------------------.
//! :          Users             :         Implementors           :       Peace        :
//! :----------------------------:--------------------------------:--------------------:
//! :                            :                                :                    :
//! :                            :   .-------------------.        :                    :
//! :                            :   | #[derive(Params)] |        : ---.               :
//! :                            :   | struct MyParams;  |        :    |               :
//! :                            :   '-------------------'        :    '               :
//! :                            :                                :  proc macro        :
//! :                            : .----------------------------. :  generates         :
//! :                            : | * MyParamsFieldWise        | :    .               :
//! :                            : | * MyParamsPartial          | :    |               :
//! :                            : | * MyParamsFieldWiseBuilder | : <--'               :
//! :                            : | * impl Params for MyParams | :                    :
//! :                            : '----------------------------' :                    :
//! :                            :                                :                    :
//! :                            :   .-------------------.        :                    :
//! :                            :   | struct MyItem;    |        :                    :
//! :                            :   |                   |        : ---.               :
//! :                            :   | impl Item for     |        :    |               :
//! :                            :   |   MyItem {        |        :    |               :
//! :                            :   |     type Params = |        :    '               :
//! :                            :   |     MyParams;     |        :  exposes API       :
//! :                            :   | }                 |        :  with constraints  :
//! :                            :   '-------------------'        :  from              :
//! :                            :                                :  <Item::Params     :
//! : .------------------------. :                                :    as Params>      :
//! : | cmd_ctx_builder        | :                                :    .               :
//! : | .with_item_params      | <-------------------------------------'               :
//! : |    ::<IS>(             | :                                :                    :
//! : |     item_id,           | :                                :                    :
//! : |     my_p_spec_builder  | :                                :                    :
//! : |       .with_f(123)     | :                                :                    :
//! : |       .with_from(..)   | :                                :                    :
//! : |     /* .build() */     | :                                :                    :
//! : |   )                    | :                                :                    :
//! : '------------------------' :                                :                    :
//! :                            :                                :                    :
//! '----------------------------------------------------------------------------------'
//! ```

// Re-exports
pub use peace_params_derive::{value_impl, Params, ParamsFieldless};
pub use tynm;

pub use crate::{
    any_spec_data_type::AnySpecDataType,
    any_spec_rt::AnySpecRt,
    any_spec_rt_boxed::AnySpecRtBoxed,
    field_name_and_type::FieldNameAndType,
    field_wise_spec_rt::FieldWiseSpecRt,
    func::{FromFunc, Func},
    mapping_fn::MappingFn,
    mapping_fn_impl::MappingFnImpl,
    params::Params,
    params_fieldless::ParamsFieldless,
    params_key::ParamsKey,
    params_merge_ext::ParamsMergeExt,
    params_resolve_error::ParamsResolveError,
    params_spec::ParamsSpec,
    params_spec_de::ParamsSpecDe,
    params_spec_fieldless::ParamsSpecFieldless,
    params_spec_fieldless_de::ParamsSpecFieldlessDe,
    params_specs::ParamsSpecs,
    params_value::ParamsValue,
    value_resolution_ctx::ValueResolutionCtx,
    value_resolution_mode::ValueResolutionMode,
    value_spec::ValueSpec,
    value_spec_de::ValueSpecDe,
    value_spec_rt::ValueSpecRt,
};

mod any_spec_data_type;
mod any_spec_rt;
mod any_spec_rt_boxed;
mod field_name_and_type;
mod field_wise_spec_rt;
mod func;
mod mapping_fn;
mod mapping_fn_impl;
mod params;
mod params_fieldless;
mod params_key;
mod params_merge_ext;
mod params_resolve_error;
mod params_spec;
mod params_spec_de;
mod params_spec_fieldless;
mod params_spec_fieldless_de;
mod params_specs;
mod params_value;
mod std_impl;
mod value_resolution_ctx;
mod value_resolution_mode;
mod value_spec;
mod value_spec_de;
mod value_spec_rt;