Union nix::sys::socket::SockaddrStorage

#[repr(C)]
pub union SockaddrStorage {
    /* private fields */
}

Available on crate feature socket only.

A container for any sockaddr type

Just like C’s sockaddr_storage, this type is large enough to hold any type of sockaddr. It can be used as an argument with functions like bind and getsockname. Though it is a union, it can be safely accessed through the as_* methods.

Example

let localhost = SockaddrIn::from_str("127.0.0.1:8081").unwrap();
let fd = socket(AddressFamily::Inet, SockType::Stream, SockFlag::empty(),
    None).unwrap();
bind(fd, &localhost).expect("bind");
let ss: SockaddrStorage = getsockname(fd).expect("getsockname");
assert_eq!(&localhost, ss.as_sockaddr_in().unwrap());

Implementations

impl SockaddrStorage

pub fn as_unix_addr(&self) -> Option<&UnixAddr>

Downcast to an immutable [UnixAddr] reference.

pub fn as_unix_addr_mut(&mut self) -> Option<&mut UnixAddr>

Downcast to a mutable [UnixAddr] reference.

pub fn as_link_addr(&self) -> Option<&LinkAddr>

Safely and falliably downcast to an immutable reference

pub fn as_link_addr_mut(&mut self) -> Option<&mut LinkAddr>

Safely and falliably downcast to a mutable reference

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

Safely and falliably downcast to an immutable reference

pub fn as_sockaddr_in_mut(&mut self) -> Option<&mut SockaddrIn>

Safely and falliably downcast to a mutable reference

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

Safely and falliably downcast to an immutable reference

pub fn as_sockaddr_in6_mut(&mut self) -> Option<&mut SockaddrIn6>

Safely and falliably downcast to a mutable reference

pub fn as_sys_control_addr(&self) -> Option<&SysControlAddr>

Safely and falliably downcast to an immutable reference

pub fn as_sys_control_addr_mut(&mut self) -> Option<&mut SysControlAddr>

Safely and falliably downcast to a mutable reference

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<SocketAddr> for SockaddrStorage

fn from(s: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for SockaddrStorage

fn from(s: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for SockaddrStorage

fn from(s: SocketAddrV6) -> Self

Converts to this type from the input type.

impl Hash for SockaddrStorage

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

fn eq(&self, other: &Self) -> 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 SockaddrStorage

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

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 SockaddrStorage

impl Eq for SockaddrStorage