<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `ToSocketAddrs` trait in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ToSocketAddrs">
<title>std::net::ToSocketAddrs - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc trait">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Trait ToSocketAddrs</p><div class="block items"><ul><li><a href="#associated-types">Associated Types</a></li><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>net</a></p><script>window.sidebarCurrent = {name: 'ToSocketAddrs', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>std</a>::<wbr><a href='index.html'>net</a>::<wbr><a class="trait" href=''>ToSocketAddrs</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../src/std/net/addr.rs.html#733-748' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait ToSocketAddrs {
type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a><Item = <a class="enum" href="../../std/net/enum.SocketAddr.html" title="enum std::net::SocketAddr">SocketAddr</a>>;
fn <a href='#tymethod.to_socket_addrs' class='fnname'>to_socket_addrs</a>(&self) -> <a class="type" href="../../std/io/type.Result.html" title="type std::io::Result">Result</a><Self::<a class="trait" href="../../std/net/trait.ToSocketAddrs.html" title="trait std::net::ToSocketAddrs">Iter</a>>;
}</pre><div class='docblock'><p>A trait for objects which can be converted or resolved to one or more
<a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a> values.</p>
<p>This trait is used for generic address resolution when constructing network
objects. By default it is implemented for the following types:</p>
<ul>
<li><p><a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a>: <a href="#tymethod.to_socket_addrs"><code>to_socket_addrs</code></a> is the identity function.</p></li>
<li><p><a href="../../std/net/struct.SocketAddrV4.html"><code>SocketAddrV4</code></a>, <a href="../../std/net/struct.SocketAddrV6.html"><code>SocketAddrV6</code></a>, <code>(</code><a href="../../std/net/enum.IpAddr.html"><code>IpAddr</code></a><code>,</code><a href="../../std/primitive.u16.html"><code>u16</code></a><code>)</code>,
<code>(</code><a href="../../std/net/struct.Ipv4Addr.html"><code>Ipv4Addr</code></a><code>,</code><a href="../../std/primitive.u16.html"><code>u16</code></a><code>)</code>, <code>(</code><a href="../../std/net/struct.Ipv6Addr.html"><code>Ipv6Addr</code></a><code>,</code><a href="../../std/primitive.u16.html"><code>u16</code></a><code>)</code>:
<a href="#tymethod.to_socket_addrs"><code>to_socket_addrs</code></a> constructs a <a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a> trivially.</p></li>
<li><p><code>(</code><a href="../../std/primitive.str.html"><code>&str</code></a><code>,</code><a href="../../std/primitive.u16.html"><code>u16</code></a><code>)</code>: the string should be either a string representation
of an <a href="../../std/net/enum.IpAddr.html"><code>IpAddr</code></a> address as expected by <a href="../../std/str/trait.FromStr.html"><code>FromStr</code></a> implementation or a host
name.</p></li>
<li><p><a href="../../std/primitive.str.html"><code>&str</code></a>: the string should be either a string representation of a
<a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a> as expected by its <a href="../../std/str/trait.FromStr.html"><code>FromStr</code></a> implementation or a string like
<code><host_name>:<port></code> pair where <code><port></code> is a <a href="../../std/primitive.u16.html"><code>u16</code></a> value.</p></li>
</ul>
<p>This trait allows constructing network objects like <a href="../../std/net/struct.TcpStream.html"><code>TcpStream</code></a> or
<a href="../../std/net/struct.UdpSocket.html"><code>UdpSocket</code></a> 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 <code>"localhost:12345"</code> is much nicer
than manual construction of the corresponding <a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a>, but sometimes
<a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a> value is <em>the</em> main source of the address, and converting it to
some other type (e.g. a string) just for it to be converted back to
<a href="../../std/net/enum.SocketAddr.html"><code>SocketAddr</code></a> in constructor methods is pointless.</p>
<p>Addresses returned by the operating system that are not IP addresses are
silently ignored.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::{<span class="ident">SocketAddrV4</span>, <span class="ident">TcpStream</span>, <span class="ident">UdpSocket</span>, <span class="ident">TcpListener</span>, <span class="ident">Ipv4Addr</span>};
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="ident">ip</span> <span class="op">=</span> <span class="ident">Ipv4Addr</span>::<span class="ident">new</span>(<span class="number">127</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>);
<span class="kw">let</span> <span class="ident">port</span> <span class="op">=</span> <span class="number">12345</span>;
<span class="comment">// The following lines are equivalent modulo possible "localhost" name</span>
<span class="comment">// resolution differences</span>
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="ident">SocketAddrV4</span>::<span class="ident">new</span>(<span class="ident">ip</span>, <span class="ident">port</span>));
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>((<span class="ident">ip</span>, <span class="ident">port</span>));
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>((<span class="string">"127.0.0.1"</span>, <span class="ident">port</span>));
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>((<span class="string">"localhost"</span>, <span class="ident">port</span>));
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="string">"127.0.0.1:12345"</span>);
<span class="kw">let</span> <span class="ident">tcp_s</span> <span class="op">=</span> <span class="ident">TcpStream</span>::<span class="ident">connect</span>(<span class="string">"localhost:12345"</span>);
<span class="comment">// TcpListener::bind(), UdpSocket::bind() and UdpSocket::send_to()</span>
<span class="comment">// behave similarly</span>
<span class="kw">let</span> <span class="ident">tcp_l</span> <span class="op">=</span> <span class="ident">TcpListener</span>::<span class="ident">bind</span>(<span class="string">"localhost:12345"</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">udp_s</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>((<span class="string">"127.0.0.1"</span>, <span class="ident">port</span>)).<span class="ident">unwrap</span>();
<span class="ident">udp_s</span>.<span class="ident">send_to</span>(<span class="kw-2">&</span>[<span class="number">7</span>], (<span class="ident">ip</span>, <span class="number">23451</span>)).<span class="ident">unwrap</span>();
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=use%20std%3A%3Anet%3A%3A%7BSocketAddrV4%2C%20TcpStream%2C%20UdpSocket%2C%20TcpListener%2C%20Ipv4Addr%7D%3B%0A%0Afn%20main()%20%7B%0A%20%20%20%20let%20ip%20%3D%20Ipv4Addr%3A%3Anew(127%2C%200%2C%200%2C%201)%3B%0A%20%20%20%20let%20port%20%3D%2012345%3B%0A%0A%20%20%20%20%2F%2F%20The%20following%20lines%20are%20equivalent%20modulo%20possible%20%22localhost%22%20name%0A%20%20%20%20%2F%2F%20resolution%20differences%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect(SocketAddrV4%3A%3Anew(ip%2C%20port))%3B%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect((ip%2C%20port))%3B%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect((%22127.0.0.1%22%2C%20port))%3B%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect((%22localhost%22%2C%20port))%3B%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect(%22127.0.0.1%3A12345%22)%3B%0A%20%20%20%20let%20tcp_s%20%3D%20TcpStream%3A%3Aconnect(%22localhost%3A12345%22)%3B%0A%0A%20%20%20%20%2F%2F%20TcpListener%3A%3Abind()%2C%20UdpSocket%3A%3Abind()%20and%20UdpSocket%3A%3Asend_to()%0A%20%20%20%20%2F%2F%20behave%20similarly%0A%20%20%20%20let%20tcp_l%20%3D%20TcpListener%3A%3Abind(%22localhost%3A12345%22)%3B%0A%0A%20%20%20%20let%20mut%20udp_s%20%3D%20UdpSocket%3A%3Abind((%22127.0.0.1%22%2C%20port)).unwrap()%3B%0A%20%20%20%20udp_s.send_to(%26%5B7%5D%2C%20(ip%2C%2023451)).unwrap()%3B%0A%7D%0A">Run</a></pre>
</div>
<h2 id='associated-types'>Associated Types</h2>
<div class='methods'>
<h3 id='associatedtype.Iter' class='method'><span id='Iter.t' class='invisible'><code>type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a><Item = <a class="enum" href="../../std/net/enum.SocketAddr.html" title="enum std::net::SocketAddr">SocketAddr</a>></code></span></h3><div class='docblock'><p>Returned iterator over socket addresses which this type may correspond
to.</p>
</div></div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.to_socket_addrs' class='method'><span id='to_socket_addrs.v' class='invisible'><code>fn <a href='#tymethod.to_socket_addrs' class='fnname'>to_socket_addrs</a>(&self) -> <a class="type" href="../../std/io/type.Result.html" title="type std::io::Result">Result</a><Self::<a class="trait" href="../../std/net/trait.ToSocketAddrs.html" title="trait std::net::ToSocketAddrs">Iter</a>></code></span></h3><div class='docblock'><p>Converts this object to an iterator of resolved <code>SocketAddr</code>s.</p>
<p>The returned iterator may not actually yield any values depending on the
outcome of any resolution performed.</p>
<p>Note that this function may block the current thread while resolution is
performed.</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl ToSocketAddrs for <a class="enum" href="../../std/net/enum.SocketAddr.html" title="enum std::net::SocketAddr">SocketAddr</a></code></li>
<li><code>impl ToSocketAddrs for <a class="struct" href="../../std/net/struct.SocketAddrV4.html" title="struct std::net::SocketAddrV4">SocketAddrV4</a></code></li>
<li><code>impl ToSocketAddrs for <a class="struct" href="../../std/net/struct.SocketAddrV6.html" title="struct std::net::SocketAddrV6">SocketAddrV6</a></code></li>
<li><code>impl ToSocketAddrs for <a class="primitive" href="../primitive.tuple.html">(</a><a class="enum" href="../../std/net/enum.IpAddr.html" title="enum std::net::IpAddr">IpAddr</a>, <a class="primitive" href="../primitive.u16.html">u16</a><a class="primitive" href="../primitive.tuple.html">)</a></code></li>
<li><code>impl ToSocketAddrs for <a class="primitive" href="../primitive.tuple.html">(</a><a class="struct" href="../../std/net/struct.Ipv4Addr.html" title="struct std::net::Ipv4Addr">Ipv4Addr</a>, <a class="primitive" href="../primitive.u16.html">u16</a><a class="primitive" href="../primitive.tuple.html">)</a></code></li>
<li><code>impl ToSocketAddrs for <a class="primitive" href="../primitive.tuple.html">(</a><a class="struct" href="../../std/net/struct.Ipv6Addr.html" title="struct std::net::Ipv6Addr">Ipv6Addr</a>, <a class="primitive" href="../primitive.u16.html">u16</a><a class="primitive" href="../primitive.tuple.html">)</a></code></li>
<li><code>impl<'a> ToSocketAddrs for <a class="primitive" href="../primitive.tuple.html">(</a>&'a <a class="primitive" href="../primitive.str.html">str</a>, <a class="primitive" href="../primitive.u16.html">u16</a><a class="primitive" href="../primitive.tuple.html">)</a></code></li>
<li><code>impl ToSocketAddrs for <a class="primitive" href="../primitive.str.html">str</a></code></li>
<li><code>impl<'a> ToSocketAddrs for <a class="primitive" href="../primitive.slice.html">&'a [</a><a class="enum" href="../../std/net/enum.SocketAddr.html" title="enum std::net::SocketAddr">SocketAddr</a><a class="primitive" href="../primitive.slice.html">]</a></code></li>
<li><code>impl<'a, T: <a class="trait" href="../../std/net/trait.ToSocketAddrs.html" title="trait std::net::ToSocketAddrs">ToSocketAddrs</a> + ?<a class="trait" href="../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>> ToSocketAddrs for &'a T</code></li>
<li><code>impl ToSocketAddrs for <a class="struct" href="../../std/string/struct.String.html" title="struct std::string::String">String</a></code></li>
</ul><script type="text/javascript" async
src="../../implementors/std/net/trait.ToSocketAddrs.js">
</script></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "std";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
564935689ab5527f955e5449ded02799
>
files
>
4384
