volo 0.12.3

Volo is a high-performance and strong-extensibility Rust RPC framework that helps developers build microservices.
Documentation
pub mod conn;
pub mod dial;
pub mod ext;
pub mod incoming;
#[cfg(feature = "shmipc")]
pub mod shmipc;
#[cfg(feature = "shmipc")]
pub mod shmipc_fallback;
#[cfg(feature = "__tls")]
#[cfg_attr(docsrs, doc(cfg(any(feature = "rustls", feature = "native-tls"))))]
pub mod tls;

mod probe;

#[cfg(target_os = "linux")]
use std::os::linux::net::SocketAddrExt;
#[cfg(target_family = "unix")]
use std::os::unix::net::SocketAddr as StdUnixSocketAddr;
use std::{
    fmt,
    hash::Hash,
    net::{Ipv6Addr, SocketAddr},
};

pub use incoming::{DefaultIncoming, MakeIncoming};
#[cfg(target_family = "unix")]
use tokio::net::unix::SocketAddr as TokioUnixSocketAddr;

#[derive(Clone, Debug)]
pub enum Address {
    Ip(SocketAddr),
    #[cfg(target_family = "unix")]
    Unix(StdUnixSocketAddr),
    #[cfg(feature = "shmipc")]
    Shmipc(crate::net::shmipc::Address),
}

impl Address {
    pub const fn is_ip(&self) -> bool {
        matches!(self, Self::Ip(_))
    }

    #[cfg(target_family = "unix")]
    pub const fn is_unix(&self) -> bool {
        matches!(self, Self::Unix(_))
    }

    #[cfg(feature = "shmipc")]
    pub const fn is_shmipc(&self) -> bool {
        matches!(self, Self::Shmipc(_))
    }

    pub const fn ip_addr(&self) -> Option<&SocketAddr> {
        match self {
            Self::Ip(ip) => Some(ip),
            #[cfg(target_family = "unix")]
            Self::Unix(_) => None,
            #[cfg(feature = "shmipc")]
            Self::Shmipc(_) => None,
        }
    }

    #[cfg(target_family = "unix")]
    pub const fn unix_addr(&self) -> Option<&StdUnixSocketAddr> {
        match self {
            Self::Ip(_) => None,
            Self::Unix(unix) => Some(unix),
            #[cfg(feature = "shmipc")]
            Self::Shmipc(_) => None,
        }
    }

    #[cfg(feature = "shmipc")]
    pub const fn shmipc_addr(&self) -> Option<&crate::net::shmipc::Address> {
        match self {
            Self::Ip(_) => None,
            #[cfg(target_family = "unix")]
            Self::Unix(_) => None,
            #[cfg(feature = "shmipc")]
            Self::Shmipc(addr) => Some(addr),
        }
    }
}

impl PartialEq for Address {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (Self::Ip(self_ip), Self::Ip(other_ip)) => self_ip == other_ip,
            #[cfg(target_family = "unix")]
            (Self::Unix(self_uds), Self::Unix(other_uds)) => {
                match (self_uds.as_pathname(), other_uds.as_pathname()) {
                    (Some(self_pathname), Some(other_pathname)) => self_pathname == other_pathname,
                    (None, None) => {
                        // Both uds are unnamed, so they cannot be compared.
                        //
                        // We noticed that the `PartialEq`, `Eq` and `Hash` are only used for load
                        // balance, and load balace can only be used for TCP connection.  So we can
                        // treat the unnamed uds as the same.
                        true
                    }
                    // named and unnamed must be different
                    _ => false,
                }
            }
            #[cfg(feature = "shmipc")]
            // There should only be one shmipc connection, just treat them as the same.
            (Self::Shmipc(self_shmipc), Self::Shmipc(other_shmipc)) => self_shmipc.eq(other_shmipc),
            #[cfg(any(target_family = "unix", feature = "shmipc"))]
            _ => false,
        }
    }
}

impl Eq for Address {}

impl Hash for Address {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        match self {
            Self::Ip(ip) => {
                state.write_u8(0);
                Hash::hash(ip, state);
            }
            #[cfg(target_family = "unix")]
            Self::Unix(uds) => {
                #[cfg(target_os = "linux")]
                if let Some(abs_name) = uds.as_abstract_name() {
                    state.write_u8(1);
                    Hash::hash(abs_name, state);
                    return;
                }
                if let Some(pathname) = uds.as_pathname() {
                    state.write_u8(2);
                    Hash::hash(pathname, state);
                } else {
                    state.write_u8(3);
                }
            }
            #[cfg(feature = "shmipc")]
            Self::Shmipc(addr) => {
                state.write_u8(4);
                Hash::hash(addr, state);
            }
        }
    }
}

impl Address {
    pub fn favor_dual_stack(self) -> Self {
        match self {
            Self::Ip(addr) => {
                if addr.ip().is_unspecified() && should_favor_ipv6() {
                    Self::Ip((Ipv6Addr::UNSPECIFIED, addr.port()).into())
                } else {
                    self
                }
            }
            #[cfg(target_family = "unix")]
            _ => self,
        }
    }
}

fn should_favor_ipv6() -> bool {
    let probed = probe::probe();
    !probed.ipv4 || probed.ipv4_mapped_ipv6
}

impl fmt::Display for Address {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Ip(addr) => write!(f, "{addr}"),
            #[cfg(target_family = "unix")]
            Self::Unix(addr) => {
                #[cfg(target_os = "linux")]
                if let Some(abs_name) = addr.as_abstract_name() {
                    return write!(f, "{}", abs_name.escape_ascii());
                }
                if let Some(pathname) = addr.as_pathname() {
                    write!(f, "{}", pathname.to_string_lossy())
                } else {
                    f.write_str("(unnamed)")
                }
            }
            #[cfg(feature = "shmipc")]
            Self::Shmipc(addr) => write!(f, "shmipc: {addr}"),
        }
    }
}

impl From<SocketAddr> for Address {
    fn from(addr: SocketAddr) -> Self {
        Address::Ip(addr)
    }
}

#[cfg(target_family = "unix")]
impl From<StdUnixSocketAddr> for Address {
    fn from(value: StdUnixSocketAddr) -> Self {
        Address::Unix(value)
    }
}

#[cfg(target_family = "unix")]
impl From<TokioUnixSocketAddr> for Address {
    fn from(value: TokioUnixSocketAddr) -> Self {
        // SAFETY: `std::mem::transmute` can ensure both struct has the same size, so there is no
        // need for checking it.
        Address::Unix(unsafe {
            std::mem::transmute::<tokio::net::unix::SocketAddr, std::os::unix::net::SocketAddr>(
                value,
            )
        })
    }
}

#[cfg(feature = "shmipc")]
pub struct ShmipcAddr<A>(pub A);

#[cfg(feature = "shmipc")]
impl<A> From<ShmipcAddr<A>> for Address
where
    A: Into<self::shmipc::addr::Address>,
{
    fn from(value: ShmipcAddr<A>) -> Self {
        value.0.into().into()
    }
}

#[cfg(feature = "shmipc")]
impl From<self::shmipc::Address> for Address {
    fn from(value: self::shmipc::Address) -> Self {
        Address::Shmipc(value)
    }
}