Enum nix::sys::socket::SockAddr

#[non_exhaustive]
pub enum SockAddr {
    Inet(InetAddr),
    Unix(UnixAddr),
    Netlink(NetlinkAddr),
    Alg(AlgAddr),
    Link(LinkAddr),
    Vsock(VsockAddr),
}

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Represents a socket address

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Inet(InetAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Unix(UnixAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Netlink(NetlinkAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Alg(AlgAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Link(LinkAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Datalink address (MAC)

Vsock(VsockAddr)

👎Deprecated since 0.24.0: use SockaddrLike or SockaddrStorage instead

Implementations

impl SockAddr

pub fn new_inet(addr: InetAddr) -> SockAddr

pub fn new_unix<P: ?Sized + NixPath>(path: &P) -> Result<SockAddr>

pub fn new_netlink(pid: u32, groups: u32) -> SockAddr

pub fn new_alg(alg_type: &str, alg_name: &str) -> SockAddr

pub fn new_vsock(cid: u32, port: u32) -> SockAddr

pub fn family(&self) -> AddressFamily

pub fn to_str(&self) -> String

👎Deprecated since 0.23.0: use .to_string() instead

pub fn as_ffi_pair(&self) -> (&sockaddr, socklen_t)

Conversion from nix’s SockAddr type to the underlying libc sockaddr type.

This is useful for interfacing with other libc functions that don’t yet have nix wrappers. Returns a reference to the underlying data type (as a sockaddr reference) along with the size of the actual data type. sockaddr is commonly used as a proxy for a superclass as C doesn’t support inheritance, so many functions that take a sockaddr * need to take the size of the underlying type as well and then internally cast it back.

Trait Implementations

impl Clone for SockAddr

fn clone(&self) -> SockAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SockAddr

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

Formats the value using the given formatter.

impl Display for SockAddr

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

Formats the value using the given formatter.

impl Hash for SockAddr

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<SockAddr> for SockAddr

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl SockaddrLike for SockAddr

unsafe fn from_raw(
    addr: *const sockaddr,
    _len: Option<socklen_t>
) -> Option<Self>

Unsafe constructor from a variable length source

fn as_ptr(&self) -> *const sockaddr

Returns a raw pointer to the inner structure. Useful for FFI.

fn family(&self) -> Option<AddressFamily>

Return the address family of this socket

fn len(&self) -> socklen_t

Return the length of valid data in the sockaddr structure.

fn size() -> socklen_twhere
    Self: Sized,

Return the available space in the structure

impl Copy for SockAddr

impl Eq for SockAddr

impl StructuralEq for SockAddr

impl StructuralPartialEq for SockAddr