Struct shadow_rs::utility::sockaddr::SockaddrStorage

pub struct SockaddrStorage { /* private fields */ }

A container for any type of socket address.

Implementations

impl SockaddrStorage

pub unsafe fn from_ptr( addr: *const MaybeUninit<u8>, len: socklen_t, ) -> Option<SockaddrStorage>

Safety

• The address must be fully initialized, including padding fields (for example sockaddr_in.sin_zero), up until len bytes.
• Padding bytes do not need to be initialized.
• The address does not need to be aligned.
• If len is large enough for the address to hold the family field, the family must correctly represent the address type. For example if addr points to a sockaddr_in, then addr.sin_family must be AF_INET.

pub unsafe fn from_bytes(address: &[MaybeUninit<u8>]) -> Option<Self>

Safety

See Self::from_ptr.

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

Get the socket protocol family. Will return None if the socket address length is too short.

pub fn as_inet(&self) -> Option<&SockaddrIn>

If the socket address represents a valid ipv4 socket address (correct family and length), returns the ipv4 socket address.

pub fn from_inet(addr: &SockaddrIn) -> Self

Get a new SockaddrStorage with a copy of the ipv4 socket address.

pub fn as_inet6(&self) -> Option<&SockaddrIn6>

If the socket address represents a valid ipv6 socket address (correct family and length), returns the ipv6 socket address.

pub fn from_inet6(addr: &SockaddrIn6) -> Self

Get a new SockaddrStorage with a copy of the ipv6 socket address.

pub fn as_unix(&self) -> Option<SockaddrUnix<&sockaddr_un>>

If the socket address represents a valid unix socket address (correct family and length), returns the unix socket address.

pub fn from_unix(addr: &SockaddrUnix<&sockaddr_un>) -> Self

Get a new SockaddrStorage with a copy of the unix socket address.

pub fn as_netlink(&self) -> Option<&NetlinkAddr>

If the socket address represents a valid netlink socket address (correct family and length), returns the netlink socket address.

pub fn from_netlink(addr: &NetlinkAddr) -> Self

Get a new SockaddrStorage with a copy of the netlink socket address.

pub fn as_ptr(&self) -> (*const MaybeUninit<u8>, socklen_t)

A pointer to the socket address. Some bytes may be uninitialized.

pub fn as_slice(&self) -> &[MaybeUninit<u8>]

The socket address as a slice of bytes. Some bytes may be uninitialized.

Trait Implementations

impl Clone for SockaddrStorage

fn clone(&self) -> SockaddrStorage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SockaddrStorage

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

Formats the value using the given formatter.

impl Display for SockaddrStorage

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

Formats the value using the given formatter.

impl From<NetlinkAddr> for SockaddrStorage

fn from(addr: NetlinkAddr) -> Self

Converts to this type from the input type.

impl From<SockaddrIn> for SockaddrStorage

fn from(addr: SockaddrIn) -> Self

Converts to this type from the input type.

impl From<SockaddrIn6> for SockaddrStorage

fn from(addr: SockaddrIn6) -> Self

Converts to this type from the input type.

impl<T> From<SockaddrUnix<T>> for SockaddrStorage

where T: Borrow<sockaddr_un>,

fn from(addr: SockaddrUnix<T>) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for SockaddrStorage

fn from(addr: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for SockaddrStorage

fn from(addr: SocketAddrV6) -> Self

Converts to this type from the input type.

impl Copy for SockaddrStorage