Returns true if this address is an unnamed address from the AF_UNIX family (for local interprocess communication), false otherwise.

Returns this address as Unix SocketAddr if it is an AF_UNIX pathname address, otherwise returns None.

Returns this address as a Path reference if it is an AF_UNIX pathname address, otherwise returns None.

Returns this address as a slice of bytes representing an abstract address if it is an AF_UNIX abstract address, otherwise returns None.

Abstract addresses are a Linux extension, so this method returns None on all non-Linux platforms.

Constructs a SockAddr with the family AF_VSOCK and the provided CID/port.

Errors

This function can never fail. In a future version of this library it will be made infallible.

Returns this address VSOCK CID/port if it is in the AF_VSOCK family, otherwise return None.

Create a SockAddr from the underlying storage and its length.

Safety

Caller must ensure that the address family and length match the type of storage address. For example if storage.ss_family is set to AF_INET the storage must be initialised as sockaddr_in, setting the content and length appropriately.

Examples

# fn main() -> std::io::Result<()> {
# #[cfg(unix)] {
use std::io;
use std::os::fd::AsRawFd;

use socket2::{SockAddr, SockAddrStorage, Socket, Domain, Type};

let socket = Socket::new(Domain::IPV4, Type::STREAM, None)?;

// Initialise a `SocketAddr` by calling `getsockname(2)`.
let mut addr_storage = SockAddrStorage::zeroed();
let mut len = addr_storage.size_of();

// The `getsockname(2)` system call will initialize `storage` for
// us, setting `len` to the correct length.
let res = unsafe {
    libc::getsockname(
        socket.as_raw_fd(),
        addr_storage.view_as(),
        &mut len,
    )
};
if res == -1 {
    return Err(io::Error::last_os_error());
}

let address = unsafe { SockAddr::new(addr_storage, len) };
# drop(address);
# }
# Ok(())
# }

Initialise a SockAddr by calling the function init.

The type of the address storage and length passed to the function init is OS/architecture specific.

The address is zeroed before init is called and is thus valid to dereference and read from. The length initialised to the maximum length of the storage.

Safety

Caller must ensure that the address family and length match the type of storage address. For example if storage.ss_family is set to AF_INET the storage must be initialised as sockaddr_in, setting the content and length appropriately.

Examples

# fn main() -> std::io::Result<()> {
# #[cfg(unix)] {
use std::io;
use std::os::fd::AsRawFd;

use socket2::{SockAddr, Socket, Domain, Type};

let socket = Socket::new(Domain::IPV4, Type::STREAM, None)?;

// Initialise a `SocketAddr` by calling `getsockname(2)`.
let (_, address) = unsafe {
    SockAddr::try_init(|addr_storage, len| {
        // The `getsockname(2)` system call will initialize `storage` for
        // us, setting `len` to the correct length.
        if libc::getsockname(socket.as_raw_fd(), addr_storage.cast(), len) == -1 {
            Err(io::Error::last_os_error())
        } else {
            Ok(())
        }
    })
}?;
# drop(address);
# }
# Ok(())
# }

Constructs a SockAddr with the family AF_UNIX and the provided path.

Returns an error if the path is longer than SUN_LEN.

Set the length of the address.

Safety

Caller must ensure that the address up to length bytes are properly initialised.

Returns this address's family.

Returns this address's Domain.

Returns the size of this address in bytes.

Returns a raw pointer to the address.

Returns the address as the storage.

Returns true if this address is in the AF_INET (IPv4) family, false otherwise.

Returns true if this address is in the AF_INET6 (IPv6) family, false otherwise.

Returns true if this address is of a unix socket (for local interprocess communication), i.e. it is from the AF_UNIX family, false otherwise.

Returns this address as a SocketAddr if it is in the AF_INET (IPv4) or AF_INET6 (IPv6) family, otherwise returns None.

Returns this address as a SocketAddrV4 if it is in the AF_INET family.

Returns this address as a SocketAddrV6 if it is in the AF_INET6 family.