Struct UnixAddr

#[repr(C)]
pub struct UnixAddr {
    sun: sockaddr_un,
    sun_len: u8,
}

A wrapper around sockaddr_un.

Fields

sun: sockaddr_un

sun_len: u8

The length of the valid part of sun, including the sun_family field but excluding any trailing nul.

Implementations

impl UnixAddr

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

Create a new sockaddr_un representing a filesystem path.

pub fn new_abstract(path: &[u8]) -> Result<UnixAddr>

Create a new sockaddr_un representing an address in the “abstract namespace”.

The leading nul byte for the abstract namespace is automatically added; thus the input path is expected to be the bare name, not NUL-prefixed. This is a Linux-specific extension, primarily used to allow chrooted processes to communicate with processes having a different filesystem view.

pub fn new_unnamed() -> UnixAddr

Create a new sockaddr_un representing an “unnamed” unix socket address.

pub(crate) unsafe fn from_raw_parts(sun: sockaddr_un, sun_len: u8) -> UnixAddr

Create a UnixAddr from a raw sockaddr_un struct and a size. sun_len is the size of the valid portion of the struct, excluding any trailing NUL.

Safety

This pair of sockaddr_un & sun_len must be a valid unix addr, which means:

• sun_len >= offset_of(sockaddr_un, sun_path)
• sun_len <= sockaddr_un.sun_path.len() - offset_of(sockaddr_un, sun_path)
• if this is a unix addr with a pathname, sun.sun_path is a fs path, not necessarily nul-terminated.

fn kind(&self) -> UnixAddrKind<'_>

pub fn path(&self) -> Option<&Path>

If this address represents a filesystem path, return that path.

pub fn as_abstract(&self) -> Option<&[u8]>

If this address represents an abstract socket, return its name.

For abstract sockets only the bare name is returned, without the leading NUL byte. None is returned for unnamed or path-backed sockets.

pub fn is_unnamed(&self) -> bool

Check if this address is an “unnamed” unix socket address.

pub fn path_len(&self) -> usize

Returns the addrlen of this socket - offsetof(struct sockaddr_un, sun_path)

pub fn as_ptr(&self) -> *const sockaddr_un

Returns a pointer to the raw sockaddr_un struct

pub fn as_mut_ptr(&mut self) -> *mut sockaddr_un

Returns a mutable pointer to the raw sockaddr_un struct

fn sun_len(&self) -> u8

Trait Implementations

impl AsRef<sockaddr_un> for UnixAddr

fn as_ref(&self) -> &sockaddr_un

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UnixAddr

fn clone(&self) -> UnixAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnixAddr

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

Formats the value using the given formatter.

impl Display for UnixAddr

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

Formats the value using the given formatter.

impl Hash for UnixAddr

fn hash<H: Hasher>(&self, s: &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 UnixAddr

fn eq(&self, other: &UnixAddr) -> 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 SockaddrLike for UnixAddr

fn len(&self) -> socklen_t

Return the length of valid data in the sockaddr structure.

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

where Self: Sized,

Unsafe constructor from a variable length source

fn size() -> socklen_t

where Self: Sized,

Return the available space in the structure

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

impl SockaddrLikePriv for UnixAddr

fn as_mut_ptr(&mut self) -> *mut sockaddr

Returns a mutable raw pointer to the inner structure.

impl Copy for UnixAddr

impl Eq for UnixAddr