Skip to main content

yaiko_core/
network_endpoint.rs

1//! Validated network endpoint configuration.
2use std::net::SocketAddr;
3#[derive(Debug, Clone, Copy, PartialEq, Eq)]
4pub enum TlsMode {
5    Disabled,
6    Required,
7}
8#[derive(Debug, Clone, PartialEq, Eq)]
9pub enum NetworkError {
10    InvalidAddress,
11    InvalidTls,
12}
13#[derive(Debug, Clone, PartialEq, Eq)]
14pub struct NetworkEndpoint {
15    pub address: SocketAddr,
16    pub http2: bool,
17    pub tls: TlsMode,
18}
19impl NetworkEndpoint {
20    pub fn new(address: impl AsRef<str>) -> Result<Self, NetworkError> {
21        let address = address
22            .as_ref()
23            .parse()
24            .map_err(|_| NetworkError::InvalidAddress)?;
25        Ok(Self {
26            address,
27            http2: false,
28            tls: TlsMode::Disabled,
29        })
30    }
31    pub fn http2(mut self, enabled: bool) -> Self {
32        self.http2 = enabled;
33        self
34    }
35    pub fn tls(mut self, mode: TlsMode) -> Result<Self, NetworkError> {
36        if mode == TlsMode::Required && self.address.port() == 0 {
37            return Err(NetworkError::InvalidTls);
38        }
39        self.tls = mode;
40        Ok(self)
41    }
42    pub fn scheme(&self) -> &'static str {
43        match self.tls {
44            TlsMode::Disabled => "http",
45            TlsMode::Required => "https",
46        }
47    }
48    pub fn describe(&self) -> String {
49        format!(
50            "{}://{}{}",
51            self.scheme(),
52            self.address,
53            if self.http2 { "?http2=1" } else { "" }
54        )
55    }
56}
57#[cfg(test)]
58mod tests {
59    use super::*;
60    #[test]
61    fn builds_deterministic_endpoint() {
62        let e = NetworkEndpoint::new("127.0.0.1:8443")
63            .unwrap()
64            .http2(true)
65            .tls(TlsMode::Required)
66            .unwrap();
67        assert_eq!(e.describe(), "https://127.0.0.1:8443?http2=1")
68    }
69    #[test]
70    fn validates_address_and_tls() {
71        assert!(NetworkEndpoint::new("bad").is_err());
72        assert!(NetworkEndpoint::new("127.0.0.1:0")
73            .unwrap()
74            .tls(TlsMode::Required)
75            .is_err())
76    }
77}