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

use std::fmt::Debug;

use serde::{de::DeserializeOwned, Serialize};

use crate::FieldWiseSpecRt;

/// Input parameters to an item.
///
/// This trait is automatically implemented by
/// `#[derive(peace::params::Params)]`.
pub trait Params: Clone + Debug + Serialize + DeserializeOwned + Send + Sync + 'static {
    /// Convenience associated type for `ValueSpec<Self>`.
    type Spec: Clone + Debug + Serialize + DeserializeOwned + Send + Sync + 'static;
    /// The `Params` type, where each field is wrapped in [`Option`].
    type Partial: Clone + Debug + Default + Send + Sync + 'static;
    /// The `Params` type, where each field is wrapped with
    /// [`ParamsSpecFieldless<T>`].
    ///
    /// Specifies how to look up values for each field in the `Value`.
    ///
    /// [`ParamsSpecFieldless<T>`]: crate::ParamsSpecFieldless
    type FieldWiseSpec: FieldWiseSpecRt<ValueType = Self, Partial = Self::Partial>
        + Clone
        + Debug
        + Serialize
        + DeserializeOwned
        + Send
        + Sync
        + 'static;

    /// Builder to return the `FieldWiseSpec` type.
    type FieldWiseBuilder;

    /// Returns a builder to construct the `FieldWise` spec.
    fn field_wise_spec() -> Self::FieldWiseBuilder;
}