kellnr-settings 7.2.0

Kellnr is a self-hosted registry for Rust crates with support for rustdocs and crates.io caching.
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

use clap::ValueEnum;
use serde::{Deserialize, Deserializer, Serialize};
use utoipa::ToSchema;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, ValueEnum, ToSchema)]
#[schema(rename_all = "lowercase")]
pub enum Protocol {
    #[default]
    Http,
    Https,
}

impl std::fmt::Display for Protocol {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Protocol::Http => write!(f, "http"),
            Protocol::Https => write!(f, "https"),
        }
    }
}

impl<'de> Deserialize<'de> for Protocol {
    fn deserialize<D>(de: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        match String::deserialize(de)?.to_lowercase().as_str() {
            "http" => Ok(Self::Http),
            "https" => Ok(Self::Https),
            other => Err(serde::de::Error::custom(format!(
                "unknown protocol {other:?}; expected \"http\" or \"https\""
            ))),
        }
    }
}

impl Serialize for Protocol {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(&self.to_string())
    }
}

#[cfg(test)]
mod tests {
    use serde::Deserialize;

    use super::*;

    #[test]
    fn test_protocol_display() {
        assert_eq!(Protocol::Http.to_string(), "http");
        assert_eq!(Protocol::Https.to_string(), "https");
    }

    #[derive(Debug, Deserialize)]
    struct Settings {
        protocol: Protocol,
    }

    #[test]
    fn test_deserialize_protocol_https() {
        let toml = r#"
            protocol = "https"
        "#;

        let settings: Settings = toml::from_str(toml).unwrap();
        assert_eq!(settings.protocol, Protocol::Https);
    }

    #[test]
    fn test_deserialize_protocol_http() {
        let toml = r#"
            protocol = "http"
        "#;

        let settings: Settings = toml::from_str(toml).unwrap();
        assert_eq!(settings.protocol, Protocol::Http);
    }

    #[test]
    fn test_deserialize_protocol_uppercase() {
        let toml = r#"
            protocol = "HTTPS"
        "#;

        let settings: Settings = toml::from_str(toml).unwrap();
        assert_eq!(settings.protocol, Protocol::Https);
    }

    #[test]
    fn test_deserialize_protocol_error() {
        let toml = r#"
            protocol = "ftp"
        "#;

        let settings: Result<Settings, toml::de::Error> = toml::from_str(toml);
        assert!(settings.is_err());
    }

    #[test]
    fn test_serialize_protocol_http() {
        let protocol = Protocol::Http;
        let json = serde_json::to_string(&protocol).unwrap();
        assert_eq!(json, r#""http""#);
    }

    #[test]
    fn test_serialize_protocol_https() {
        let protocol = Protocol::Https;
        let json = serde_json::to_string(&protocol).unwrap();
        assert_eq!(json, r#""https""#);
    }
}