openvpn-mgmt-codec 0.8.0

OpenVPN management protocol codecs (tokio-util en/decoder implementations).
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

use std::str::FromStr;

/// Error returned when a string is not a recognized transport protocol.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
#[error("unrecognized transport protocol: {0:?}")]
pub struct ParseTransportProtocolError(pub String);

/// Transport protocol as reported in `>REMOTE:` and `>PROXY:` notifications.
#[derive(Debug, Clone, PartialEq, Eq, strum::Display)]
#[strum(serialize_all = "lowercase")]
pub enum TransportProtocol {
    /// UDP transport.
    Udp,

    /// TCP transport.
    Tcp,

    /// An unrecognized protocol (forward compatibility).
    #[strum(default)]
    Unknown(String),
}

impl FromStr for TransportProtocol {
    type Err = ParseTransportProtocolError;

    /// Parse a recognized protocol string (case-insensitive: `udp`/`UDP`,
    /// `tcp`/`TCP`).
    fn from_str(input: &str) -> Result<Self, Self::Err> {
        match input {
            "udp" | "UDP" => Ok(Self::Udp),
            "tcp" | "TCP" => Ok(Self::Tcp),
            other => Err(ParseTransportProtocolError(other.to_string())),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_lowercase() {
        assert_eq!(
            "udp".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Udp
        );
        assert_eq!(
            "tcp".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Tcp
        );
    }

    #[test]
    fn parse_uppercase() {
        assert_eq!(
            "UDP".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Udp
        );
        assert_eq!(
            "TCP".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Tcp
        );
    }

    #[test]
    fn mixed_case_is_err() {
        assert!("Udp".parse::<TransportProtocol>().is_err());
        assert!("Tcp".parse::<TransportProtocol>().is_err());
    }

    #[test]
    fn display_roundtrip() {
        // strum Display serializes as lowercase
        assert_eq!(TransportProtocol::Udp.to_string(), "udp");
        assert_eq!(TransportProtocol::Tcp.to_string(), "tcp");
        assert_eq!(
            "udp".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Udp
        );
        assert_eq!(
            "tcp".parse::<TransportProtocol>().unwrap(),
            TransportProtocol::Tcp
        );
    }

    #[test]
    fn unknown_protocol_is_err() {
        assert!("sctp".parse::<TransportProtocol>().is_err());
    }

    #[test]
    fn display_unknown() {
        let u = TransportProtocol::Unknown("quic".to_string());
        assert_eq!(u.to_string(), "quic");
    }

    #[test]
    fn error_preserves_input() {
        let err = "sctp".parse::<TransportProtocol>().unwrap_err();
        assert_eq!(err.0, "sctp");
    }
}