Struct SockAddrStorage 

pub struct SockAddrStorage(pub SOCKADDR_STORAGE);

The SockAddrStorage struct represents a socket address for IPv4 or IPv6 addresses. It can be created from various Windows socket address types and can be converted to a std::net::SocketAddr.

Tuple Fields

0: SOCKADDR_STORAGE

Implementations

impl SockAddrStorage

pub fn new() -> Self

Constructs a new SockAddrStorage with all fields set to zero.

pub fn from_ip_string(ip_address: &str) -> Result<Self, AddrParseError>

Constructs a new SockAddrStorage instance from a string representation of an IPv4 or IPv6 address.

Arguments

• ip_address - A string representation of an IPv4 or IPv6 address.

Returns

A Result containing a new SockAddrStorage instance, or an error if the input string is not a valid IP address.

pub fn from_sockaddr(address: SOCKADDR) -> Self

Constructs a new SockAddrStorage from a SOCKADDR struct.

Safety

This function uses MaybeUninit to safely create an uninitialized SOCKADDR_STORAGE instance, and then it copies the SOCKADDR contents into the SOCKADDR_STORAGE without overlapping. Before constructing the SockAddrStorage, it ensures that the contents are valid using the assume_init() method.

pub fn from_sockaddr_in(address: SOCKADDR_IN) -> Self

Constructs a new SockAddrStorage from a SOCKADDR_IN struct.

Safety

This function uses MaybeUninit to safely create an uninitialized SOCKADDR_STORAGE instance, and then it copies the SOCKADDR_IN contents into the SOCKADDR_STORAGE without overlapping. Before constructing the SockAddrStorage, it ensures that the contents are valid using the assume_init() method.

pub fn from_sockaddr_in6(address: SOCKADDR_IN6) -> Self

Constructs a new SockAddrStorage from a SOCKADDR_IN6 struct.

Safety

This function uses MaybeUninit to safely create an uninitialized SOCKADDR_STORAGE instance, and then it copies the SOCKADDR_IN6 contents into the SOCKADDR_STORAGE without overlapping. Before constructing the SockAddrStorage, it ensures that the contents are valid using the assume_init() method.

pub fn from_ipv4_addr(address: Ipv4Addr) -> Self

Constructs a new SockAddrStorage from an Ipv4Addr object.

pub fn from_ipv6_addr(address: Ipv6Addr) -> Self

Constructs a new SockAddrStorage from an Ipv6Addr object.

pub fn to_socket_addr(&self) -> Option<SocketAddr>

Converts the SockAddrStorage to a std::net::SocketAddr if it contains a valid IPv4 or IPv6 address.

pub fn to_string(&self) -> Option<String>

Converts the SockAddrStorage to a String representation of the IP address and port.

pub fn to_wide_string(&self) -> Option<String>

Converts the SockAddrStorage to a wide String representation of the IP address and port.

Trait Implementations

impl Clone for SockAddrStorage

fn clone(&self) -> SockAddrStorage

Returns a duplicate 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 Default for SockAddrStorage

fn default() -> Self

Returns the “default value” for a type.

impl From<SockAddrStorage> for IpAddr

fn from(ip_address_info: SockAddrStorage) -> Self

Converts to this type from the input type.

impl PartialEq for SockAddrStorage

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

impl Eq for SockAddrStorage

impl StructuralPartialEq for SockAddrStorage