Struct os_socketaddr::OsSocketAddr

pub struct OsSocketAddr { /* private fields */ }

A type for handling platform-native socket addresses (struct sockaddr)

This type has a buffer big enough to hold a [libc::sockaddr_in] or [libc::sockaddr_in6] struct. Its content can be arbitrary written using .as_mut() or .as_mut_ptr().

It also provides the conversion functions from/into SocketAddr.

See crate level documentation.

Implementations

impl OsSocketAddr

pub fn new() -> Self

Create a new empty socket address

pub unsafe fn from_raw_parts(ptr: *const u8, len: usize) -> Self

Create a new socket address from a raw slice

Panics

Panics if len is bigger that the size of sockaddr_in6

pub fn from(addr: SocketAddr) -> Self

Create a new socket address from a SocketAddr object

pub fn into_addr(self) -> Option<SocketAddr>

Attempt to convert the internal buffer into a SocketAddr object

The internal buffer is assumed to be a sockaddr.

If the value of .sa_family resolves to AF_INET or AF_INET6 then the buffer is converted into SocketAddr, otherwise the function returns None.

pub fn len(&self) -> socklen_t

Return the length of the address

The result depends on the value of .sa_family in the internal buffer:

• AF_INET -> the size of sockaddr_in
• AF_INET6 -> the size of sockaddr_in6
• other -> 0

pub fn capacity(&self) -> socklen_t

Return the size of the internal buffer

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

Get a pointer to the internal buffer

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

Get a mutable pointer to the internal buffer

Trait Implementations

impl AsMut<[u8]> for OsSocketAddr

fn as_mut(&mut self) -> &mut [u8]

Get the internal buffer as a mutable slice

impl AsRef<[u8]> for OsSocketAddr

fn as_ref(&self) -> &[u8]

Get the internal buffer as a byte slice

Note: the actual length of slice depends on the value of .sa_family (see .len())

impl Clone for OsSocketAddr

fn clone(&self) -> OsSocketAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OsSocketAddr

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

Formats the value using the given formatter.

impl From<Option<SocketAddr>> for OsSocketAddr

fn from(addr: Option<SocketAddr>) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for OsSocketAddr

fn from(addr: SocketAddr) -> Self

Converts to this type from the input type.

impl Into<Option<SocketAddr>> for OsSocketAddr

fn into(self) -> Option<SocketAddr>

Attempt to convert the internal buffer into a SocketAddr object

The internal buffer is assumed to be a sockaddr.

If the value of .sa_family resolves to AF_INET or AF_INET6 then the buffer is converted into SocketAddr, otherwise the function returns None.

impl TryInto<SocketAddr> for OsSocketAddr

fn try_into(self) -> Result<SocketAddr, BadFamilyError>

Attempt to convert the internal buffer into a SocketAddr object

The internal buffer is assumed to be a sockaddr.

If the value of .sa_family resolves to AF_INET or AF_INET6 then the buffer is converted into SocketAddr, otherwise the function returns an error.

type Error = BadFamilyError

The type returned in the event of a conversion error.

impl Copy for OsSocketAddr