specler 0.21.0

A simple way to write specifications on values
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

use std::marker::PhantomData;
use crate::core::spec::spec_provider::SpecProvider;
use crate::core::spec_error::SpecError;

/// # Validated
///
/// Enum documenting the result of running the provided spec
/// against a struct with a single value.
pub enum Validated<T,S>
where
    T: Clone,
    S: SpecProvider<T>
{
    /// Marks a validation output as valid based on the spec
    Valid {
        /// The valid value that passed the spec validation
        value: T,
        /// The spec that was used to validate the input
        _spec: PhantomData<S>
    },
    /// Marks a validation output as invalid based on the spec
    Invalid {
        /// The error describing why the input data was invalid
        error: SpecError,
        /// The spec that was used to invalidate the input
        _spec: PhantomData<S>
    }
}

impl <T, U> From<T> for Validated<T, U>
where
    T: Clone,
    U: SpecProvider<T>
{
    fn from(value: T) -> Validated<T, U> {
        let spec = U::spec();
        match spec.validate(value) {
            Ok(v) => Validated::Valid {
                value: v,
                _spec: PhantomData
            },
            Err(e) => Validated::Invalid {
                error: e,
                _spec: PhantomData
            }
        }
    }
}