Enum SocketAddr

pub enum SocketAddr {
    Inet(SocketAddr),
    Unix(SocketAddr),
}

A unified address type that can represent both std::net::SocketAddr and unix::SocketAddr (a wrapper over std::os::unix::net::SocketAddr).

Notes

For Unix domain sockets addresses, serialization/deserialization will be performed in URI format (see UNIX_URI_PREFIX), which is different from unix::SocketAddr’s serialization/deserialization behaviour.

Variants

Inet(SocketAddr)

See std::net::SocketAddr.

Unix(SocketAddr)

See unix::SocketAddr.

Implementations

impl SocketAddr

pub fn new(addr: &str) -> Result<Self>

Creates a new SocketAddr from its string representation.

The string can be in one of the following formats:

• Network socket address: "127.0.0.1:8080", "[::1]:8080"
• Unix domain socket (pathname): "unix:///run/listen.sock"
• Unix domain socket (abstract): "unix://@abstract.unix.socket"

Examples

// Network addresses
let addr_v4 = SocketAddr::new("127.0.0.1:8080").unwrap();
let addr_v6 = SocketAddr::new("[::1]:8080").unwrap();

// Unix domain sockets
let addr_unix_filename = SocketAddr::new("unix:///run/listen.sock").unwrap();
let addr_unix_abstract = SocketAddr::new("unix://@abstract.unix.socket").unwrap();

See unix::SocketAddr::new for more details on Unix socket address formats.

pub fn bind_std(&self) -> Result<StdListener>

Binds a standard (TCP) listener to the address.

pub async fn bind(&self) -> Result<Listener>

Binds a Tokio (TCP) listener to the address.

pub fn to_string_ext(&self) -> Option<String>

Serializes the address to a String.

Trait Implementations

impl Clone for SocketAddr

fn clone(&self) -> SocketAddr

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocketAddr

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SocketAddr

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SocketAddr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SocketAddr

fn eq(&self, other: &SocketAddr) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SocketAddr

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SocketAddr

impl StructuralPartialEq for SocketAddr