Struct SocketAddrAny

pub struct SocketAddrAny { /* private fields */ }

Available on crate feature net only.

A type that can hold any kind of socket address, as a safe abstraction for sockaddr_storage.

Socket addresses can be converted to SocketAddrAny via the From and Into traits. SocketAddrAny can be converted back to a specific socket address type with TryFrom and TryInto. These implementations return Errno::AFNOSUPPORT if the address family does not match the requested type.

Implementations

impl SocketAddrAny

pub const unsafe fn new( storage: MaybeUninit<SocketAddrStorage>, len: SocketAddrLen, ) -> Self

Creates a socket address from storage, which is initialized for len bytes.

Panics

if len is smaller than the sockaddr header or larger than SocketAddrStorage.

Safety

• storage must contain a valid socket address.
• len bytes must be initialized.

pub unsafe fn read(ptr: *const SocketAddrStorage, len: SocketAddrLen) -> Self

Creates a socket address from reading from ptr, which points at len initialized bytes.

Panics

if len is smaller than the sockaddr header or larger than SocketAddrStorage.

Safety

• ptr must be a pointer to memory containing a valid socket address.
• len bytes must be initialized.

pub fn address_family(&self) -> AddressFamily

Gets the address family of this socket address.

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

Returns a raw pointer to the sockaddr.

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

Returns a raw mutable pointer to the sockaddr.

pub fn addr_len(&self) -> SocketAddrLen

Returns the length of the encoded sockaddr.

Trait Implementations

impl Clone for SocketAddrAny

fn clone(&self) -> SocketAddrAny

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddrAny

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

Formats the value using the given formatter.

impl From<SocketAddr> for SocketAddrAny

fn from(from: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddrNetlink> for SocketAddrAny

fn from(from: SocketAddrNetlink) -> Self

Converts to this type from the input type.

impl From<SocketAddrUnix> for SocketAddrAny

fn from(from: SocketAddrUnix) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for SocketAddrAny

fn from(from: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for SocketAddrAny

fn from(from: SocketAddrV6) -> Self

Converts to this type from the input type.

impl From<SocketAddrXdp> for SocketAddrAny

fn from(from: SocketAddrXdp) -> Self

Converts to this type from the input type.

impl Hash for SocketAddrAny

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 Ord for SocketAddrAny

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SocketAddrAny

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SocketAddrArg for SocketAddrAny

unsafe fn with_sockaddr<R>( &self, f: impl FnOnce(*const SocketAddrOpaque, SocketAddrLen) -> R, ) -> R

Call a closure with the pointer and length to the corresponding C type.

fn as_any(&self) -> SocketAddrAny

Convert to SocketAddrAny.

unsafe fn write_sockaddr( &self, storage: *mut SocketAddrStorage, ) -> SocketAddrLen

Encode an address into a SocketAddrStorage.

impl TryFrom<SocketAddrAny> for SocketAddr

fn try_from(value: SocketAddrAny) -> Result<Self, Self::Error>

Convert if the address is an IPv4 or IPv6 address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not IPv4 or IPv6.

type Error = Errno

The type returned in the event of a conversion error.

impl TryFrom<SocketAddrAny> for SocketAddrNetlink

type Error = Errno

The type returned in the event of a conversion error.

fn try_from(addr: SocketAddrAny) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SocketAddrAny> for SocketAddrUnix

fn try_from(value: SocketAddrAny) -> Result<Self, Self::Error>

Convert if the address is a Unix socket address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not Unix.

type Error = Errno

The type returned in the event of a conversion error.

impl TryFrom<SocketAddrAny> for SocketAddrV4

fn try_from(value: SocketAddrAny) -> Result<Self, Self::Error>

Convert if the address is an IPv4 address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not IPv4.

type Error = Errno

The type returned in the event of a conversion error.

impl TryFrom<SocketAddrAny> for SocketAddrV6

fn try_from(value: SocketAddrAny) -> Result<Self, Self::Error>

Convert if the address is an IPv6 address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not IPv6.

type Error = Errno

The type returned in the event of a conversion error.

impl TryFrom<SocketAddrAny> for SocketAddrXdp

type Error = Errno

The type returned in the event of a conversion error.

fn try_from(addr: SocketAddrAny) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SocketAddrAny