schematic 0.20.1

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

#[cfg(feature = "schema")]
use crate::schema::{Schema, SchemaBuilder, Schematic};
use semver::{Error, Version};
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};
use std::ops::Deref;
use std::str::FromStr;

/// A [`Version`] that can be used as a setting.
///
/// [`Version`] does not implement `Default`, which a required setting needs,
/// and cannot be given it from here as it is a foreign type. Its serde support
/// also sits behind a `semver` feature that `schematic` does not enable, so
/// this wrapper (de)serializes from the version string instead.
///
/// Defaults to `0.0.0`.
///
/// `VersionReq` needs no equivalent, as it already defaults to `*`.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(try_from = "String", into = "String")]
pub struct VersionSetting(pub Version);

impl VersionSetting {
    /// Parse a version from a string.
    pub fn new(value: impl AsRef<str>) -> Result<Self, Error> {
        Ok(Self(Version::parse(value.as_ref())?))
    }
}

/// Defaults to `0.0.0`.
impl Default for VersionSetting {
    fn default() -> Self {
        Self(Version::new(0, 0, 0))
    }
}

/// Derefs to the inner [`Version`], so its methods can be called directly.
impl Deref for VersionSetting {
    type Target = Version;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl FromStr for VersionSetting {
    type Err = Error;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::new(value)
    }
}

impl TryFrom<&str> for VersionSetting {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Self::new(value)
    }
}

impl TryFrom<String> for VersionSetting {
    type Error = Error;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::new(value)
    }
}

#[allow(clippy::from_over_into)]
impl Into<String> for VersionSetting {
    fn into(self) -> String {
        self.to_string()
    }
}

impl PartialEq<VersionSetting> for VersionSetting {
    fn eq(&self, other: &VersionSetting) -> bool {
        self.0.eq(&other.0)
    }
}

impl Eq for VersionSetting {}

impl Hash for VersionSetting {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.0.hash(state);
    }
}

#[cfg(feature = "schema")]
impl Schematic for VersionSetting {
    fn build_schema(_: SchemaBuilder) -> Schema {
        SchemaBuilder::generate::<Version>()
    }
}