Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / tokio / net / trait.ToSocketAddrs.html
blob: 147a8517849cb55e4fe47fa3d1f1384dda7ea050 [file] [log] [blame]
<!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="Converts or resolves without blocking to one or more `SocketAddr` values."><meta name="keywords" content="rust, rustlang, rust-lang, ToSocketAddrs"><title>ToSocketAddrs in tokio::net - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ToSocketAddrs</a></h2><div class="sidebar-elems"><section><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ToSocketAddrs-for-%26T">&amp;T</a></li><li><a href="#impl-ToSocketAddrs-for-%26%5BSocketAddr%5D">&amp;[SocketAddr]</a></li><li><a href="#impl-ToSocketAddrs-for-(%26str%2C%20u16)">(&amp;str, u16)</a></li><li><a href="#impl-ToSocketAddrs-for-(IpAddr%2C%20u16)">(IpAddr, u16)</a></li><li><a href="#impl-ToSocketAddrs-for-(Ipv4Addr%2C%20u16)">(Ipv4Addr, u16)</a></li><li><a href="#impl-ToSocketAddrs-for-(Ipv6Addr%2C%20u16)">(Ipv6Addr, u16)</a></li><li><a href="#impl-ToSocketAddrs-for-(String%2C%20u16)">(String, u16)</a></li><li><a href="#impl-ToSocketAddrs-for-SocketAddr">SocketAddr</a></li><li><a href="#impl-ToSocketAddrs-for-SocketAddrV4">SocketAddrV4</a></li><li><a href="#impl-ToSocketAddrs-for-SocketAddrV6">SocketAddrV6</a></li><li><a href="#impl-ToSocketAddrs-for-String">String</a></li><li><a href="#impl-ToSocketAddrs-for-str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tokio::net</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">tokio</a>::<wbr><a href="index.html">net</a>::<wbr><a class="trait" href="#">ToSocketAddrs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio/net/addr.rs.html#19">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ToSocketAddrs: ToSocketAddrsPriv { }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Converts or resolves without blocking to one or more <code>SocketAddr</code> values.</p>
<h2 id="dns"><a href="#dns">DNS</a></h2>
<p>Implementations of <code>ToSocketAddrs</code> for string types require a DNS lookup.</p>
<h2 id="calling"><a href="#calling">Calling</a></h2>
<p>Currently, this trait is only used as an argument to Tokio functions that
need to reference a target socket address. To perform a <code>SocketAddr</code>
conversion directly, use <a href="fn.lookup_host.html"><code>lookup_host()</code></a>.</p>
<p>This trait is sealed and is intended to be opaque. The details of the trait
will change. Stabilization is pending enhancements to the Rust language.</p>
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><section id="impl-ToSocketAddrs-for-%26T" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#34">source</a><a href="#impl-ToSocketAddrs-for-%26T" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;<a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</h3></section><section id="impl-ToSocketAddrs-for-SocketAddr" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#50">source</a><a href="#impl-ToSocketAddrs-for-SocketAddr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/socket_addr/enum.SocketAddr.html" title="enum std::net::socket_addr::SocketAddr">SocketAddr</a></h3></section><section id="impl-ToSocketAddrs-for-SocketAddrV4" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#64">source</a><a href="#impl-ToSocketAddrs-for-SocketAddrV4" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/socket_addr/struct.SocketAddrV4.html" title="struct std::net::socket_addr::SocketAddrV4">SocketAddrV4</a></h3></section><section id="impl-ToSocketAddrs-for-SocketAddrV6" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#77">source</a><a href="#impl-ToSocketAddrs-for-SocketAddrV6" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/socket_addr/struct.SocketAddrV6.html" title="struct std::net::socket_addr::SocketAddrV6">SocketAddrV6</a></h3></section><section id="impl-ToSocketAddrs-for-(IpAddr%2C%20u16)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#90">source</a><a href="#impl-ToSocketAddrs-for-(IpAddr%2C%20u16)" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for (<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/enum.IpAddr.html" title="enum std::net::ip_addr::IpAddr">IpAddr</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</h3></section><section id="impl-ToSocketAddrs-for-(Ipv4Addr%2C%20u16)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#104">source</a><a href="#impl-ToSocketAddrs-for-(Ipv4Addr%2C%20u16)" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for (<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</h3></section><section id="impl-ToSocketAddrs-for-(Ipv6Addr%2C%20u16)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#118">source</a><a href="#impl-ToSocketAddrs-for-(Ipv6Addr%2C%20u16)" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for (<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</h3></section><section id="impl-ToSocketAddrs-for-%26%5BSocketAddr%5D" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#132">source</a><a href="#impl-ToSocketAddrs-for-%26%5BSocketAddr%5D" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for &amp;[<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/socket_addr/enum.SocketAddr.html" title="enum std::net::socket_addr::SocketAddr">SocketAddr</a>]</h3></section><section id="impl-ToSocketAddrs-for-str" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#162">source</a><a href="#impl-ToSocketAddrs-for-str" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h3></section><section id="impl-ToSocketAddrs-for-(%26str%2C%20u16)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#190">source</a><a href="#impl-ToSocketAddrs-for-(%26str%2C%20u16)" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for (&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</h3></section><section id="impl-ToSocketAddrs-for-(String%2C%20u16)" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#227">source</a><a href="#impl-ToSocketAddrs-for-(String%2C%20u16)" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for (<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>)</h3></section><section id="impl-ToSocketAddrs-for-String" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/addr.rs.html#240">source</a><a href="#impl-ToSocketAddrs-for-String" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../implementors/tokio/net/addr/trait.ToSocketAddrs.js" data-ignore-extern-crates="std,alloc" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>