Trait no_std_net::ToSocketAddrs

pub trait ToSocketAddrs {
    type Iter: Iterator<Item = SocketAddr>;
    pub fn to_socket_addrs(&self) -> Result<Self::Iter, ToSocketAddrError>;
}

A trait for objects which can be converted or resolved to one or more SocketAddr values.

This trait is used for generic address resolution when constructing network objects. By default it is implemented for the following types:

• SocketAddr: to_socket_addrs is the identity function.

• SocketAddrV4, SocketAddrV6, (IpAddr, u16), (Ipv4Addr, u16), (Ipv6Addr, u16): to_socket_addrs constructs a SocketAddr trivially.

• (&str, u16): the string should be either a string representation of an IpAddr address as expected by FromStr implementation or a host name.

• &str: the string should be either a string representation of a SocketAddr as expected by its FromStr implementation or a string like <host_name>:<port> pair where <port> is a u16 value.

This trait allows constructing network objects like TcpStream or UdpSocket easily with values of various types for the bind/connection address. It is needed because sometimes one type is more appropriate than the other: for simple uses a string like "localhost:12345" is much nicer than manual construction of the corresponding SocketAddr, but sometimes SocketAddr value is the main source of the address, and converting it to some other type (e.g. a string) just for it to be converted back to SocketAddr in constructor methods is pointless.

Addresses returned by the operating system that are not IP addresses are silently ignored.

Associated Types

type Iter: Iterator<Item = SocketAddr>

Returned iterator over socket addresses which this type may correspond to.

Loading content...

Required methods

pub fn to_socket_addrs(&self) -> Result<Self::Iter, ToSocketAddrError>

Converts this object to an iterator of resolved SocketAddrs.

The returned iterator may not actually yield any values depending on the outcome of any resolution performed.

Note that this function may block the current thread while resolution is performed.

Loading content...

Implementors

impl ToSocketAddrs for (IpAddr, u16)

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl ToSocketAddrs for (Ipv4Addr, u16)

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl ToSocketAddrs for (Ipv6Addr, u16)

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl ToSocketAddrs for SocketAddr

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl ToSocketAddrs for SocketAddrV4

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl ToSocketAddrs for SocketAddrV6

type Iter = IntoIter<SocketAddr>

pub fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>, ToSocketAddrError>

impl<'a> ToSocketAddrs for &'a [SocketAddr]

type Iter = Cloned<Iter<'a, SocketAddr>>

pub fn to_socket_addrs(&self) -> Result<Self::Iter, ToSocketAddrError>

impl<'a, T: ToSocketAddrs + ?Sized> ToSocketAddrs for &'a T

type Iter = T::Iter

pub fn to_socket_addrs(&self) -> Result<T::Iter, ToSocketAddrError>

Loading content...