tor-general-addr 0.41.0

Generalized socket address type used by Tor
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

//! Definitions related to unix domain socket support.
//!
//! To avoid confusion, don't import `SocketAddr` from this module directly;
//! instead, import the module and refer to `unix::SocketAddr`.

#[cfg(not(unix))]
use std::path::Path;

/// A replacement/re-export [`std::os::unix::net::SocketAddr`].
///
/// On Unix platforms, this is just a re-export of [`std::os::unix::net::SocketAddr`].
///
/// On non-Unix platforms, this type is an uninhabited placeholder that can never be instantiated.
#[cfg(unix)]
pub use std::os::unix::net::SocketAddr;

/// Address for an AF_UNIX socket.
///
/// (This is an uninhabited placeholder implementations for platforms without AF_UNIX support.)
///
/// Note that we currently include Windows on platforms without AF_UNIX support:
/// When we use unix domain sockets in Arti, we rely on their filesystem-based security properties,
/// which we haven't yet had a chance to fully analyze on non-Unix platforms.
#[cfg(not(unix))]
#[derive(Debug, Clone)]
pub struct SocketAddr(void::Void);

#[cfg(not(unix))]
impl SocketAddr {
    /// Return true if this is an "unnamed" socket address.
    ///
    /// (Because this type is uninhabited, this method cannot actually be called.)
    pub fn is_unnamed(&self) -> bool {
        void::unreachable(self.0)
    }
    /// Return the pathname for this socket address, if it is "named".
    ///
    /// (Because this type is uninhabited, this method cannot actually be called.)
    pub fn as_pathname(&self) -> Option<&Path> {
        void::unreachable(self.0)
    }
    /// Attempt to construct an AF_UNIX socket address from the provided `path`.
    ///
    /// (Because this platform lacks AF_UNIX support, this method will always return an error.)
    pub fn from_pathname<P: AsRef<Path>>(path: P) -> std::io::Result<Self> {
        let _ = path;
        Err(NoAfUnixSocketSupport.into())
    }
}

/// Error: Unix domain sockets are not supported on this platform.
#[derive(Clone, Debug, Default, thiserror::Error)]
#[error("No support for unix domain sockets on this platform")]
#[non_exhaustive]
pub struct NoAfUnixSocketSupport;

/// Deprecated name for `NoAfUnixSocketSupport`
#[deprecated]
pub type NoUnixAddressSupport = NoAfUnixSocketSupport;

impl From<NoAfUnixSocketSupport> for std::io::Error {
    fn from(value: NoAfUnixSocketSupport) -> Self {
        std::io::Error::new(std::io::ErrorKind::Unsupported, value)
    }
}