karyon_net/
endpoint.rs

use std::{
    net::{IpAddr, SocketAddr},
    path::PathBuf,
    str::FromStr,
};

#[cfg(all(target_family = "unix", feature = "unix"))]
use std::os::unix::net::SocketAddr as UnixSocketAddr;

use bincode::{Decode, Encode};
use url::Url;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::{Error, Result};

/// Port defined as a u16.
pub type Port = u16;

/// Endpoint defines generic network endpoints for karyon.
///
/// # Example
///
/// ```
/// use std::net::SocketAddr;
///
/// use karyon_net::Endpoint;
///
/// let endpoint: Endpoint = "tcp://127.0.0.1:3000".parse().unwrap();
///
/// let socketaddr: SocketAddr = "127.0.0.1:3000".parse().unwrap();
/// let endpoint =  Endpoint::new_udp_addr(socketaddr);
///
/// ```
///
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(into = "String"))]
pub enum Endpoint {
    Udp(Addr, Port),
    Tcp(Addr, Port),
    Tls(Addr, Port),
    Ws(Addr, Port),
    Wss(Addr, Port),
    Unix(PathBuf),
}

impl Endpoint {
    /// Creates a new TCP endpoint from a `SocketAddr`.
    pub fn new_tcp_addr(addr: SocketAddr) -> Endpoint {
        Endpoint::Tcp(Addr::Ip(addr.ip()), addr.port())
    }

    /// Creates a new UDP endpoint from a `SocketAddr`.
    pub fn new_udp_addr(addr: SocketAddr) -> Endpoint {
        Endpoint::Udp(Addr::Ip(addr.ip()), addr.port())
    }

    /// Creates a new TLS endpoint from a `SocketAddr`.
    pub fn new_tls_addr(addr: SocketAddr) -> Endpoint {
        Endpoint::Tls(Addr::Ip(addr.ip()), addr.port())
    }

    /// Creates a new WS endpoint from a `SocketAddr`.
    pub fn new_ws_addr(addr: SocketAddr) -> Endpoint {
        Endpoint::Ws(Addr::Ip(addr.ip()), addr.port())
    }

    /// Creates a new WSS endpoint from a `SocketAddr`.
    pub fn new_wss_addr(addr: SocketAddr) -> Endpoint {
        Endpoint::Wss(Addr::Ip(addr.ip()), addr.port())
    }

    /// Creates a new Unix endpoint from a `UnixSocketAddr`.
    pub fn new_unix_addr(addr: &std::path::Path) -> Endpoint {
        Endpoint::Unix(addr.to_path_buf())
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Tcp`.
    pub fn is_tcp(&self) -> bool {
        matches!(self, Endpoint::Tcp(..))
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Tls`.
    pub fn is_tls(&self) -> bool {
        matches!(self, Endpoint::Tls(..))
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Ws`.
    pub fn is_ws(&self) -> bool {
        matches!(self, Endpoint::Ws(..))
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Wss`.
    pub fn is_wss(&self) -> bool {
        matches!(self, Endpoint::Wss(..))
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Udp`.
    pub fn is_udp(&self) -> bool {
        matches!(self, Endpoint::Udp(..))
    }

    #[inline]
    /// Checks if the `Endpoint` is of type `Unix`.
    pub fn is_unix(&self) -> bool {
        matches!(self, Endpoint::Unix(..))
    }

    /// Returns the `Port` of the endpoint.
    pub fn port(&self) -> Result<&Port> {
        match self {
            Endpoint::Tcp(_, port)
            | Endpoint::Udp(_, port)
            | Endpoint::Tls(_, port)
            | Endpoint::Ws(_, port)
            | Endpoint::Wss(_, port) => Ok(port),
            _ => Err(Error::TryFromEndpoint),
        }
    }

    /// Returns the `Addr` of the endpoint.
    pub fn addr(&self) -> Result<&Addr> {
        match self {
            Endpoint::Tcp(addr, _)
            | Endpoint::Udp(addr, _)
            | Endpoint::Tls(addr, _)
            | Endpoint::Ws(addr, _)
            | Endpoint::Wss(addr, _) => Ok(addr),
            _ => Err(Error::TryFromEndpoint),
        }
    }
}

impl std::fmt::Display for Endpoint {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Endpoint::Udp(ip, port) => {
                write!(f, "udp://{}:{}", ip, port)
            }
            Endpoint::Tcp(ip, port) => {
                write!(f, "tcp://{}:{}", ip, port)
            }
            Endpoint::Tls(ip, port) => {
                write!(f, "tls://{}:{}", ip, port)
            }
            Endpoint::Ws(ip, port) => {
                write!(f, "ws://{}:{}", ip, port)
            }
            Endpoint::Wss(ip, port) => {
                write!(f, "wss://{}:{}", ip, port)
            }
            Endpoint::Unix(path) => {
                write!(f, "unix:/{}", path.to_string_lossy())
            }
        }
    }
}
impl From<Endpoint> for String {
    fn from(endpoint: Endpoint) -> String {
        endpoint.to_string()
    }
}

impl TryFrom<Endpoint> for SocketAddr {
    type Error = Error;
    fn try_from(endpoint: Endpoint) -> std::result::Result<SocketAddr, Self::Error> {
        match endpoint {
            Endpoint::Udp(ip, port)
            | Endpoint::Tcp(ip, port)
            | Endpoint::Tls(ip, port)
            | Endpoint::Ws(ip, port)
            | Endpoint::Wss(ip, port) => Ok(SocketAddr::new(ip.try_into()?, port)),
            Endpoint::Unix(_) => Err(Error::TryFromEndpoint),
        }
    }
}

impl TryFrom<Endpoint> for PathBuf {
    type Error = Error;
    fn try_from(endpoint: Endpoint) -> std::result::Result<PathBuf, Self::Error> {
        match endpoint {
            Endpoint::Unix(path) => Ok(PathBuf::from(&path)),
            _ => Err(Error::TryFromEndpoint),
        }
    }
}

#[cfg(all(feature = "unix", target_family = "unix"))]
impl TryFrom<Endpoint> for UnixSocketAddr {
    type Error = Error;
    fn try_from(endpoint: Endpoint) -> std::result::Result<UnixSocketAddr, Self::Error> {
        match endpoint {
            Endpoint::Unix(a) => Ok(UnixSocketAddr::from_pathname(a)?),
            _ => Err(Error::TryFromEndpoint),
        }
    }
}

impl FromStr for Endpoint {
    type Err = Error;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        let url: Url = match s.parse() {
            Ok(u) => u,
            Err(err) => return Err(Error::ParseEndpoint(err.to_string())),
        };

        if url.has_host() {
            let host = url.host_str().unwrap();

            let addr = match host.parse::<IpAddr>() {
                Ok(addr) => Addr::Ip(addr),
                Err(_) => Addr::Domain(host.to_string()),
            };

            let port = match url.port() {
                Some(p) => p,
                None => return Err(Error::ParseEndpoint(format!("port missing: {s}"))),
            };

            match url.scheme() {
                "tcp" => Ok(Endpoint::Tcp(addr, port)),
                "udp" => Ok(Endpoint::Udp(addr, port)),
                "tls" => Ok(Endpoint::Tls(addr, port)),
                "ws" => Ok(Endpoint::Ws(addr, port)),
                "wss" => Ok(Endpoint::Wss(addr, port)),
                _ => Err(Error::UnsupportedEndpoint(s.to_string())),
            }
        } else {
            if url.path().is_empty() {
                return Err(Error::UnsupportedEndpoint(s.to_string()));
            }

            match url.scheme() {
                "unix" => Ok(Endpoint::Unix(url.path().into())),
                _ => Err(Error::UnsupportedEndpoint(s.to_string())),
            }
        }
    }
}

/// Addr defines a type for an address, either IP or domain.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Encode, Decode)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Addr {
    Ip(IpAddr),
    Domain(String),
}

impl TryFrom<Addr> for IpAddr {
    type Error = std::io::Error;
    fn try_from(addr: Addr) -> std::result::Result<IpAddr, Self::Error> {
        match addr {
            Addr::Ip(ip) => Ok(ip),
            Addr::Domain(_) => Err(std::io::ErrorKind::Unsupported.into()),
        }
    }
}

impl std::fmt::Display for Addr {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Addr::Ip(ip) => {
                write!(f, "{}", ip)
            }
            Addr::Domain(d) => {
                write!(f, "{}", d)
            }
        }
    }
}

pub trait ToEndpoint {
    fn to_endpoint(&self) -> Result<Endpoint>;
}

impl ToEndpoint for String {
    fn to_endpoint(&self) -> Result<Endpoint> {
        Endpoint::from_str(self)
    }
}

impl ToEndpoint for Endpoint {
    fn to_endpoint(&self) -> Result<Endpoint> {
        Ok(self.clone())
    }
}

impl ToEndpoint for &str {
    fn to_endpoint(&self) -> Result<Endpoint> {
        Endpoint::from_str(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::Ipv4Addr;
    use std::path::PathBuf;

    #[test]
    fn test_endpoint_from_str() {
        let endpoint_str: Endpoint = "tcp://127.0.0.1:3000".parse().unwrap();
        let endpoint = Endpoint::Tcp(Addr::Ip(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))), 3000);
        assert_eq!(endpoint_str, endpoint);

        let endpoint_str: Endpoint = "udp://127.0.0.1:4000".parse().unwrap();
        let endpoint = Endpoint::Udp(Addr::Ip(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1))), 4000);
        assert_eq!(endpoint_str, endpoint);

        let endpoint_str: Endpoint = "tcp://example.com:3000".parse().unwrap();
        let endpoint = Endpoint::Tcp(Addr::Domain("example.com".to_string()), 3000);
        assert_eq!(endpoint_str, endpoint);

        let endpoint_str = "unix:/home/x/s.socket".parse::<Endpoint>().unwrap();
        let endpoint = Endpoint::Unix(PathBuf::from_str("/home/x/s.socket").unwrap());
        assert_eq!(endpoint_str, endpoint);
    }
}
karyon_net/endpoint.rs

karyon_net/
endpoint.rs
