737 lines
123 KiB
HTML
737 lines
123 KiB
HTML
|
<!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 `UdpSocket` struct in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, UdpSocket"><title>tokio::net::UdpSocket - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tokio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct UdpSocket</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.bind">bind</a><a href="#method.broadcast">broadcast</a><a href="#method.connect">connect</a><a href="#method.from_std">from_std</a><a href="#method.join_multicast_v4">join_multicast_v4</a><a href="#method.join_multicast_v6">join_multicast_v6</a><a href="#method.leave_multicast_v4">leave_multicast_v4</a><a href="#method.leave_multicast_v6">leave_multicast_v6</a><a href="#method.local_addr">local_addr</a><a href="#method.multicast_loop_v4">multicast_loop_v4</a><a href="#method.multicast_loop_v6">multicast_loop_v6</a><a href="#method.multicast_ttl_v4">multicast_ttl_v4</a><a href="#method.peek_from">peek_from</a><a href="#method.poll_peek_from">poll_peek_from</a><a href="#method.poll_recv">poll_recv</a><a href="#method.poll_recv_from">poll_recv_from</a><a href="#method.poll_send">poll_send</a><a href="#method.poll_send_to">poll_send_to</a><a href="#method.readable">readable</a><a href="#method.ready">ready</a><a href="#method.recv">recv</a><a href="#method.recv_from">recv_from</a><a href="#method.send">send</a><a href="#method.send_to">send_to</a><a href="#method.set_broadcast">set_broadcast</a><a href="#method.set_multicast_loop_v4">set_multicast_loop_v4</a><a href="#method.set_multicast_loop_v6">set_multicast_loop_v6</a><a href="#method.set_multicast_ttl_v4">set_multicast_ttl_v4</a><a href="#method.set_ttl">set_ttl</a><a href="#method.take_error">take_error</a><a href="#method.try_recv">try_recv</a><a href="#method.try_recv_from">try_recv_from</a><a href="#method.try_send">try_send</a><a href="#method.try_send_to">try_send_to</a><a href="#method.ttl">ttl</a><a href="#method.writable">writable</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-AsRawFd">AsRawFd</a><a href="#impl-Debug">Debug</a><a href="#impl-TryFrom%3CUdpSocket%3E">TryFrom<UdpSocket></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tokio</a>::<wbr><a href="index.html">net</a></p><script>window.sidebarCurrent = {name: "UdpSocket", ty: "struct", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder=
|
||
|
|
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><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/tokio/net/udp.rs.html#110-112" title="goto source code">[src]</a></span><span class="in-band">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">net</a>::<wbr><a class="struct" href="">UdpSocket</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct UdpSocket { /* fields omitted */ }</pre></div><div class="docblock"><p>A UDP socket</p>
|
||
|
|
<p>UDP is "connectionless", unlike TCP. Meaning, regardless of what address you've bound to, a <code>UdpSocket</code>
|
||
|
|
is free to communicate with many different remotes. In tokio there are basically two main ways to use <code>UdpSocket</code>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>one to many: <a href="../../tokio/net/struct.UdpSocket.html#method.bind"><code>bind</code></a> and use <a href="../../tokio/net/struct.UdpSocket.html#method.send_to"><code>send_to</code></a>
|
||
|
|
and <a href="../../tokio/net/struct.UdpSocket.html#method.recv_from"><code>recv_from</code></a> to communicate with many different addresses</li>
|
||
|
|
<li>one to one: <a href="../../tokio/net/struct.UdpSocket.html#method.connect"><code>connect</code></a> and associate with a single address, using <a href="../../tokio/net/struct.UdpSocket.html#method.send"><code>send</code></a>
|
||
|
|
and <a href="../../tokio/net/struct.UdpSocket.html#method.recv"><code>recv</code></a> to communicate only with that remote address</li>
|
||
|
|
</ul>
|
||
|
|
<p><code>UdpSocket</code> can also be used concurrently to <code>send_to</code> and <code>recv_from</code> in different tasks,
|
||
|
|
all that's required is that you <code>Arc<UdpSocket></code> and clone a reference for each task.</p>
|
||
|
|
<h1 id="streams" class="section-header"><a href="#streams">Streams</a></h1>
|
||
|
|
<p>If you need to listen over UDP and produce a <a href="https://docs.rs/futures/0.3/futures/stream/trait.Stream.html"><code>Stream</code></a>, you can look
|
||
|
|
at <a href="https://docs.rs/tokio-util/latest/tokio_util/udp/struct.UdpFramed.html"><code>UdpFramed</code></a>.</p>
|
||
|
|
<h1 id="example-one-to-many-bind" class="section-header"><a href="#example-one-to-many-bind">Example: one to many (bind)</a></h1>
|
||
|
|
<p>Using <code>bind</code> we can create a simple echo server that sends and recv's with many different clients:</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="kw">let</span> (<span class="ident">len</span>, <span class="ident">addr</span>) <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">recv_from</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes received from {:?}"</span>, <span class="ident">len</span>, <span class="ident">addr</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">send_to</span>(<span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">len</span>], <span class="ident">addr</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes sent"</span>, <span class="ident">len</span>);
|
||
|
|
}
|
||
|
|
}</pre></div>
|
||
|
|
<h1 id="example-one-to-one-connect" class="section-header"><a href="#example-one-to-one-connect">Example: one to one (connect)</a></h1>
|
||
|
|
<p>Or using <code>connect</code> we can echo with a single remote address using <code>send</code> and <code>recv</code>:</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">remote_addr</span> <span class="op">=</span> <span class="string">"127.0.0.1:59611"</span>;
|
||
|
|
<span class="ident">sock</span>.<span class="ident">connect</span>(<span class="ident">remote_addr</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes received from {:?}"</span>, <span class="ident">len</span>, <span class="ident">remote_addr</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">send</span>(<span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">len</span>]).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes sent"</span>, <span class="ident">len</span>);
|
||
|
|
}
|
||
|
|
}</pre></div>
|
||
|
|
<h1 id="example-sendingreceiving-concurrently" class="section-header"><a href="#example-sendingreceiving-concurrently">Example: Sending/Receiving concurrently</a></h1>
|
||
|
|
<p>Because <code>send_to</code> and <code>recv_from</code> take <code>&self</code>. It's perfectly alright to <code>Arc<UdpSocket></code>
|
||
|
|
and share the references to multiple tasks, in order to send/receive concurrently. Here is
|
||
|
|
a similar "echo" example but that supports concurrent sending/receiving:</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::{<span class="ident">net</span>::<span class="ident">UdpSocket</span>, <span class="ident">sync</span>::<span class="ident">mpsc</span>};
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">io</span>, <span class="ident">net</span>::<span class="ident">SocketAddr</span>, <span class="ident">sync</span>::<span class="ident">Arc</span>};
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>()).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">sock</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">r</span>.<span class="ident">clone</span>();
|
||
|
|
<span class="kw">let</span> (<span class="ident">tx</span>, <span class="kw-2">mut</span> <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</span>::<span class="op"><</span>(<span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>, <span class="ident">SocketAddr</span>)<span class="op">></span>(<span class="number">1_000</span>);
|
||
|
|
|
||
|
|
<span class="ident">tokio</span>::<span class="ident">spawn</span>(<span class="ident">async</span> <span class="kw">move</span> {
|
||
|
|
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">bytes</span>, <span class="ident">addr</span>)) <span class="op">=</span> <span class="ident">rx</span>.<span class="ident">recv</span>().<span class="ident">await</span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">send_to</span>(<span class="kw-2">&</span><span class="ident">bytes</span>, <span class="kw-2">&</span><span class="ident">addr</span>).<span class="ident">await</span>.<span class="ident">unwrap</span>();
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes sent"</span>, <span class="ident">len</span>);
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="kw">let</span> (<span class="ident">len</span>, <span class="ident">addr</span>) <span class="op">=</span> <span class="ident">r</span>.<span class="ident">recv_from</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?} bytes received from {:?}"</span>, <span class="ident">len</span>, <span class="ident">addr</span>);
|
||
|
|
<span class="ident">tx</span>.<span class="ident">send</span>((<span class="ident">buf</span>[..<span class="ident">len</span>].<span class="ident">to_vec</span>(), <span class="ident">addr</span>)).<span class="ident">await</span>.<span class="ident">unwrap</span>();
|
||
|
|
}
|
||
|
|
}</pre></div>
|
||
|
|
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tokio/net/udp.rs.html#115-1211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.bind" class="method"><code>pub async fn <a href="#method.bind" class="fnname">bind</a><A: <a class="trait" href="../../tokio/net/trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a>>(addr: A) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#133-150" title="goto source code">[src]</a></h4><div class="docblock"><p>This function will create a new UDP socket and attempt to bind it to
|
||
|
|
the <code>addr</code> provided.</p>
|
||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="comment">// use `sock`</span>
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.from_std" class="method"><code>pub fn <a href="#method.from_std" class="fnname">from_std</a>(socket: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#197-200" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates new <code>UdpSocket</code> from a previously bound <code>std::net::UdpSocket</code>.</p>
|
||
|
|
<p>This function is intended to be used to wrap a UDP socket from the
|
||
|
|
standard library in the Tokio equivalent. The conversion assumes nothing
|
||
|
|
about the underlying socket; it is left up to the user to set it in
|
||
|
|
non-blocking mode.</p>
|
||
|
|
<p>This can be used in conjunction with socket2's <code>Socket</code> interface to
|
||
|
|
configure a socket before it's handed off, such as setting options like
|
||
|
|
<code>reuse_address</code> or binding to multiple addresses.</p>
|
||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
|
|
<p>This function panics if thread-local runtime is not set.</p>
|
||
|
|
<p>The runtime is usually set implicitly when this function is called
|
||
|
|
from a future driven by a tokio runtime, otherwise runtime can be set
|
||
|
|
explicitly with <a href="../../tokio/runtime/struct.Runtime.html#method.enter"><code>Runtime::enter</code></a> function.</p>
|
||
|
|
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="string">"0.0.0.0:8080"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">std_sock</span> <span class="op">=</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="ident">addr</span>)<span class="question-mark">?</span>;
|
||
|
|
<span class="ident">std_sock</span>.<span class="ident">set_nonblocking</span>(<span class="bool-val">true</span>)<span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">from_std</span>(<span class="ident">std_sock</span>)<span class="question-mark">?</span>;
|
||
|
|
<span class="comment">// use `sock`</span></pre></div>
|
||
|
|
</div><h4 id="method.local_addr" class="method"><code>pub fn <a href="#method.local_addr" class="fnname">local_addr</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#219-221" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the local address that this socket is bound to.</p>
|
||
|
|
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="string">"0.0.0.0:8080"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="ident">addr</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="comment">// the address the socket is bound to</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">local_addr</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">local_addr</span>()<span class="question-mark">?</span>;</pre></div>
|
||
|
|
</div><h4 id="method.connect" class="method"><code>pub async fn <a href="#method.connect" class="fnname">connect</a><A: <a class="trait" href="../../tokio/net/trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a>, '_>(&'_ self, addr: A) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#247-264" title="goto source code">[src]</a></h4><div class="docblock"><p>Connects the UDP socket setting the default destination for send() and
|
||
|
|
limiting packets that are read via recv from the address specified in
|
||
|
|
<code>addr</code>.</p>
|
||
|
|
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>()).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">remote_addr</span> <span class="op">=</span> <span class="string">"127.0.0.1:59600"</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">SocketAddr</span><span class="op">></span>().<span class="ident">unwrap</span>();
|
||
|
|
<span class="ident">sock</span>.<span class="ident">connect</span>(<span class="ident">remote_addr</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0u8</span>; <span class="number">32</span>];
|
||
|
|
<span class="comment">// recv from remote_addr</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="comment">// send to remote_addr</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">_len</span> <span class="op">=</span> <span class="ident">sock</span>.<span class="ident">send</span>(<span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">len</span>]).<span class="ident">await</span><span class="question-mark">?</span>;</pre></div>
|
||
|
|
</div><h4 id="method.ready" class="method"><code>pub async fn <a href="#method.ready" class="fnname">ready</a><'_>(&'_ self, interest: <a class="struct" href="../../tokio/io/struct.Interest.html" title="struct tokio::io::Interest">Interest</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="../../tokio/io/struct.Ready.html" title="struct tokio::io::Ready">Ready</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#325-328" title="goto source code">[src]</a></h4><div class="docblock"><p>Wait for any of the requested ready states.</p>
|
||
|
|
<p>This function is usually paired with <code>try_recv()</code> or <code>try_send()</code>. It
|
||
|
|
can be used to concurrently recv / send to the same socket on a single
|
||
|
|
task without splitting the socket.</p>
|
||
|
|
<p>The function may complete without the socket being ready. This is a
|
||
|
|
false-positive and attempting an operation will return with
|
||
|
|
<code>io::ErrorKind::WouldBlock</code>.</p>
|
||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
|
|
<p>Concurrently receive from and send to the socket on the same task
|
||
|
|
without splitting.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">io</span>::{<span class="self">self</span>, <span class="ident">Interest</span>};
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">ready</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">ready</span>(<span class="ident">Interest</span>::<span class="ident">READABLE</span> <span class="op">|</span> <span class="ident">Interest</span>::<span class="ident">WRITABLE</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">if</span> <span class="ident">ready</span>.<span class="ident">is_readable</span>() {
|
||
|
|
<span class="comment">// The buffer is **not** included in the async task and will only exist</span>
|
||
|
|
<span class="comment">// on the stack.</span>
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">data</span>[..]) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"received {:?}"</span>, <span class="kw-2">&</span><span class="ident">data</span>[..<span class="ident">n</span>]);
|
||
|
|
}
|
||
|
|
<span class="comment">// False-positive, continue</span>
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">if</span> <span class="ident">ready</span>.<span class="ident">is_writable</span>() {
|
||
|
|
<span class="comment">// Write some data</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_send</span>(<span class="string">b"hello world"</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"sent {} bytes"</span>, <span class="ident">n</span>);
|
||
|
|
}
|
||
|
|
<span class="comment">// False-positive, continue</span>
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.writable" class="method"><code>pub async fn <a href="#method.writable" class="fnname">writable</a><'_>(&'_ self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#373-376" title="goto source code">[src]</a></h4><div class="docblock"><p>Wait for the socket to become writable.</p>
|
||
|
|
<p>This function is equivalent to <code>ready(Interest::WRITABLE)</code> and is
|
||
|
|
usually paired with <code>try_send()</code> or <code>try_send_to()</code>.</p>
|
||
|
|
<p>The function may complete without the socket being writable. This is a
|
||
|
|
false-positive and attempting a <code>try_send()</code> will return with
|
||
|
|
<code>io::ErrorKind::WouldBlock</code>.</p>
|
||
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Bind socket</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="comment">// Wait for the socket to be writable</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">writable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// Try to send data, this may still fail with `WouldBlock`</span>
|
||
|
|
<span class="comment">// if the readiness event is a false positive.</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_send</span>(<span class="string">b"hello world"</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.send" class="method"><code>pub async fn <a href="#method.send" class="fnname">send</a><'_, '_>(&'_ self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#409-414" title="goto source code">[src]</a></h4><div class="docblock"><p>Sends data on the socket to the remote address that the socket is
|
||
|
|
connected to.</p>
|
||
|
|
<p>The <a href="../../tokio/net/struct.UdpSocket.html#method.connect"><code>connect</code></a> method will connect this socket to a remote address.
|
||
|
|
This method will fail if the socket is not connected.</p>
|
||
|
|
<h1 id="return" class="section-header"><a href="#return">Return</a></h1>
|
||
|
|
<p>On success, the number of bytes sent is returned, otherwise, the
|
||
|
|
encountered error is returned.</p>
|
||
|
|
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">io</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Bind socket</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// Send a message</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">send</span>(<span class="string">b"hello world"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.poll_send" class="method"><code>pub fn <a href="#method.poll_send" class="fnname">poll_send</a>(&self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#439-443" title="goto source code">[src]</a></h4><div class="docblock"><p>Attempts to send data on the socket to the remote address to which it
|
||
|
|
was previously <code>connect</code>ed.</p>
|
||
|
|
<p>The <a href="../../tokio/net/struct.UdpSocket.html#method.connect"><code>connect</code></a> method will connect this socket to a remote address.
|
||
|
|
This method will fail if the socket is not connected.</p>
|
||
|
|
<p>Note that on multiple calls to a <code>poll_*</code> method in the send direction,
|
||
|
|
only the <code>Waker</code> from the <code>Context</code> passed to the most recent call will
|
||
|
|
be scheduled to receive a wakeup.</p>
|
||
|
|
<h1 id="return-value" class="section-header"><a href="#return-value">Return value</a></h1>
|
||
|
|
<p>The function returns:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Poll::Pending</code> if the socket is not available to write</li>
|
||
|
|
<li><code>Poll::Ready(Ok(n))</code> <code>n</code> is the number of bytes sent</li>
|
||
|
|
<li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
|
|
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
|
|
</div><h4 id="method.try_send" class="method"><code>pub fn <a href="#method.try_send" class="fnname">try_send</a>(&self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#493-497" title="goto source code">[src]</a></h4><div class="docblock"><p>Try to send data on the socket to the remote address to which it is
|
||
|
|
connected.</p>
|
||
|
|
<p>When the socket buffer is full, <code>Err(io::ErrorKind::WouldBlock)</code> is
|
||
|
|
returned. This function is usually paired with <code>writable()</code>.</p>
|
||
|
|
<h1 id="returns" class="section-header"><a href="#returns">Returns</a></h1>
|
||
|
|
<p>If successful, <code>Ok(n)</code> is returned, where <code>n</code> is the number of bytes
|
||
|
|
sent. If the socket is not ready to send data,
|
||
|
|
<code>Err(ErrorKind::WouldBlock)</code> is returned.</p>
|
||
|
|
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Bind a UDP socket</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// Connect to a peer</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="comment">// Wait for the socket to be writable</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">writable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// Try to send data, this may still fail with `WouldBlock`</span>
|
||
|
|
<span class="comment">// if the readiness event is a false positive.</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_send</span>(<span class="string">b"hello world"</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.readable" class="method"><code>pub async fn <a href="#method.readable" class="fnname">readable</a><'_>(&'_ self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#547-550" title="goto source code">[src]</a></h4><div class="docblock"><p>Wait for the socket to become readable.</p>
|
||
|
|
<p>This function is equivalent to <code>ready(Interest::READABLE)</code> and is usually
|
||
|
|
paired with <code>try_recv()</code>.</p>
|
||
|
|
<p>The function may complete without the socket being readable. This is a
|
||
|
|
false-positive and attempting a <code>try_recv()</code> will return with
|
||
|
|
<code>io::ErrorKind::WouldBlock</code>.</p>
|
||
|
|
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Connect to a peer</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="comment">// Wait for the socket to be readable</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">readable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// The buffer is **not** included in the async task and will</span>
|
||
|
|
<span class="comment">// only exist on the stack.</span>
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
|
||
|
|
<span class="comment">// Try to recv data, this may still fail with `WouldBlock`</span>
|
||
|
|
<span class="comment">// if the readiness event is a false positive.</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">n</span>]);
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.recv" class="method"><code>pub async fn <a href="#method.recv" class="fnname">recv</a><'_, '_>(&'_ self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'_ mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#582-587" title="goto source code">[src]</a></h4><div class="docblock"><p>Receives a single datagram message on the socket from the remote address
|
||
|
|
to which it is connected. On success, returns the number of bytes read.</p>
|
||
|
|
<p>The function must be called with valid byte array <code>buf</code> of sufficient
|
||
|
|
size to hold the message bytes. If a message is too long to fit in the
|
||
|
|
supplied buffer, excess bytes may be discarded.</p>
|
||
|
|
<p>The <a href="../../tokio/net/struct.UdpSocket.html#method.connect"><code>connect</code></a> method will connect this socket to a remote address.
|
||
|
|
This method will fail if the socket is not connected.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Bind socket</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>; <span class="number">10</span>];
|
||
|
|
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"received {} bytes {:?}"</span>, <span class="ident">n</span>, <span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">n</span>]);
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.poll_recv" class="method"><code>pub fn <a href="#method.poll_recv" class="fnname">poll_recv</a>(<br> &self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: &mut <a class="struct" href="../../tokio/io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#612-628" title="goto source code">[src]</a></h4><div class="docblock"><p>Attempts to receive a single datagram message on the socket from the remote
|
||
|
|
address to which it is <code>connect</code>ed.</p>
|
||
|
|
<p>The <a href="../../tokio/net/struct.UdpSocket.html#method.connect"><code>connect</code></a> method will connect this socket to a remote address. This method
|
||
|
|
resolves to an error if the socket is not connected.</p>
|
||
|
|
<p>Note that on multiple calls to a <code>poll_*</code> method in the recv direction, only the
|
||
|
|
<code>Waker</code> from the <code>Context</code> passed to the most recent call will be scheduled to
|
||
|
|
receive a wakeup.</p>
|
||
|
|
<h1 id="return-value-1" class="section-header"><a href="#return-value-1">Return value</a></h1>
|
||
|
|
<p>The function returns:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Poll::Pending</code> if the socket is not ready to read</li>
|
||
|
|
<li><code>Poll::Ready(Ok(()))</code> reads data <code>ReadBuf</code> if the socket is ready</li>
|
||
|
|
<li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1>
|
||
|
|
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
|
|
</div><h4 id="method.try_recv" class="method"><code>pub fn <a href="#method.try_recv" class="fnname">try_recv</a>(&self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#680-684" title="goto source code">[src]</a></h4><div class="docblock"><p>Try to receive a single datagram message on the socket from the remote
|
||
|
|
address to which it is connected. On success, returns the number of
|
||
|
|
bytes read.</p>
|
||
|
|
<p>The function must be called with valid byte array buf of sufficient size
|
||
|
|
to hold the message bytes. If a message is too long to fit in the
|
||
|
|
supplied buffer, excess bytes may be discarded.</p>
|
||
|
|
<p>When there is no pending data, <code>Err(io::ErrorKind::WouldBlock)</code> is
|
||
|
|
returned. This function is usually paired with <code>readable()</code>.</p>
|
||
|
|
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Connect to a peer</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="comment">// Wait for the socket to be readable</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">readable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// The buffer is **not** included in the async task and will</span>
|
||
|
|
<span class="comment">// only exist on the stack.</span>
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
|
||
|
|
<span class="comment">// Try to recv data, this may still fail with `WouldBlock`</span>
|
||
|
|
<span class="comment">// if the readiness event is a false positive.</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">n</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">n</span>]);
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.send_to" class="method"><code>pub async fn <a href="#method.send_to" class="fnname">send_to</a><A: <a class="trait" href="../../tokio/net/trait.ToSocketAddrs.html" title="trait tokio::net::ToSocketAddrs">ToSocketAddrs</a>, '_, '_>(<br> &'_ self, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'_ [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> target: A<br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#716-726" title="goto source code">[src]</a></h4><div class="docblock"><p>Sends data on the socket to the given address. On success, returns the
|
||
|
|
number of bytes written.</p>
|
||
|
|
<p>Address type can be any implementor of <a href="../../tokio/net/trait.ToSocketAddrs.html"><code>ToSocketAddrs</code></a> trait. See its
|
||
|
|
documentation for concrete examples.</p>
|
||
|
|
<p>It is possible for <code>addr</code> to yield multiple addresses, but <code>send_to</code>
|
||
|
|
will only send data to the first address yielded by <code>addr</code>.</p>
|
||
|
|
<p>This will return an error when the IP version of the local socket does
|
||
|
|
not match that returned from <a href="../../tokio/net/trait.ToSocketAddrs.html"><code>ToSocketAddrs</code></a>.</p>
|
||
|
|
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">send_to</span>(<span class="string">b"hello world"</span>, <span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Sent {} bytes"</span>, <span class="ident">len</span>);
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.poll_send_to" class="method"><code>pub fn <a href="#method.poll_send_to" class="fnname">poll_send_to</a>(<br> &self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> target: <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#745-754" title="goto source code">[src]</a></h4><div class="docblock"><p>Attempts to send data on the socket to a given address.</p>
|
||
|
|
<p>Note that on multiple calls to a <code>poll_*</code> method in the send direction, only the
|
||
|
|
<code>Waker</code> from the <code>Context</code> passed to the most recent call will be scheduled to
|
||
|
|
receive a wakeup.</p>
|
||
|
|
<h1 id="return-value-2" class="section-header"><a href="#return-value-2">Return value</a></h1>
|
||
|
|
<p>The function returns:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Poll::Pending</code> if the socket is not ready to write</li>
|
||
|
|
<li><code>Poll::Ready(Ok(n))</code> <code>n</code> is the number of bytes sent.</li>
|
||
|
|
<li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="errors-2" class="section-header"><a href="#errors-2">Errors</a></h1>
|
||
|
|
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
|
|
</div><h4 id="method.try_send_to" class="method"><code>pub fn <a href="#method.try_send_to" class="fnname">try_send_to</a>(&self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, target: <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#803-807" title="goto source code">[src]</a></h4><div class="docblock"><p>Try to send data on the socket to the given address, but if the send is
|
||
|
|
blocked this will return right away.</p>
|
||
|
|
<p>This function is usually paired with <code>writable()</code>.</p>
|
||
|
|
<h1 id="returns-1" class="section-header"><a href="#returns-1">Returns</a></h1>
|
||
|
|
<p>If successfull, returns the number of bytes sent</p>
|
||
|
|
<p>Users should ensure that when the remote cannot receive, the
|
||
|
|
<a href="https://doc.rust-lang.org/nightly/std/io/error/enum.ErrorKind.html#variant.WouldBlock"><code>ErrorKind::WouldBlock</code></a> is properly handled. An error can also occur
|
||
|
|
if the IP version of the socket does not match that of <code>target</code>.</p>
|
||
|
|
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Box</span><span class="op"><</span><span class="ident">dyn</span> <span class="ident">Error</span><span class="op">></span><span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">dst</span> <span class="op">=</span> <span class="string">"127.0.0.1:8081"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="ident">socket</span>.<span class="ident">writable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_send_to</span>(<span class="kw-2">&</span><span class="string">b"hello world"</span>[..], <span class="ident">dst</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">sent</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"sent {} bytes"</span>, <span class="ident">sent</span>);
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="comment">// Writable false positive.</span>
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>.<span class="ident">into</span>()),
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.recv_from" class="method"><code>pub async fn <a href="#method.recv_from" class="fnname">recv_from</a><'_, '_>(<br> &'_ self, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'_ mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#841-846" title="goto source code">[src]</a></h4><div class="docblock"><p>Receives a single datagram message on the socket. On success, returns
|
||
|
|
the number of bytes read and the origin.</p>
|
||
|
|
<p>The function must be called with valid byte array <code>buf</code> of sufficient
|
||
|
|
size to hold the message bytes. If a message is too long to fit in the
|
||
|
|
supplied buffer, excess bytes may be discarded.</p>
|
||
|
|
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0u8</span>; <span class="number">32</span>];
|
||
|
|
<span class="kw">let</span> (<span class="ident">len</span>, <span class="ident">addr</span>) <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">recv_from</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"received {:?} bytes from {:?}"</span>, <span class="ident">len</span>, <span class="ident">addr</span>);
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.poll_recv_from" class="method"><code>pub fn <a href="#method.poll_recv_from" class="fnname">poll_recv_from</a>(<br> &self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: &mut <a class="struct" href="../../tokio/io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#865-885" title="goto source code">[src]</a></h4><div class="docblock"><p>Attempts to receive a single datagram on the socket.</p>
|
||
|
|
<p>Note that on multiple calls to a <code>poll_*</code> method in the recv direction, only the
|
||
|
|
<code>Waker</code> from the <code>Context</code> passed to the most recent call will be scheduled to
|
||
|
|
receive a wakeup.</p>
|
||
|
|
<h1 id="return-value-3" class="section-header"><a href="#return-value-3">Return value</a></h1>
|
||
|
|
<p>The function returns:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Poll::Pending</code> if the socket is not ready to read</li>
|
||
|
|
<li><code>Poll::Ready(Ok(addr))</code> reads data from <code>addr</code> into <code>ReadBuf</code> if the socket is ready</li>
|
||
|
|
<li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="errors-3" class="section-header"><a href="#errors-3">Errors</a></h1>
|
||
|
|
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
|
|
</div><h4 id="method.try_recv_from" class="method"><code>pub fn <a href="#method.try_recv_from" class="fnname">try_recv_from</a>(&self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#936-940" title="goto source code">[src]</a></h4><div class="docblock"><p>Try to receive a single datagram message on the socket. On success,
|
||
|
|
returns the number of bytes read and the origin.</p>
|
||
|
|
<p>The function must be called with valid byte array buf of sufficient size
|
||
|
|
to hold the message bytes. If a message is too long to fit in the
|
||
|
|
supplied buffer, excess bytes may be discarded.</p>
|
||
|
|
<p>When there is no pending data, <code>Err(io::ErrorKind::WouldBlock)</code> is
|
||
|
|
returned. This function is usually paired with <code>readable()</code>.</p>
|
||
|
|
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Connect to a peer</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">socket</span>.<span class="ident">connect</span>(<span class="string">"127.0.0.1:8081"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">loop</span> {
|
||
|
|
<span class="comment">// Wait for the socket to be readable</span>
|
||
|
|
<span class="ident">socket</span>.<span class="ident">readable</span>().<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="comment">// The buffer is **not** included in the async task and will</span>
|
||
|
|
<span class="comment">// only exist on the stack.</span>
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">1024</span>];
|
||
|
|
|
||
|
|
<span class="comment">// Try to recv data, this may still fail with `WouldBlock`</span>
|
||
|
|
<span class="comment">// if the readiness event is a false positive.</span>
|
||
|
|
<span class="kw">match</span> <span class="ident">socket</span>.<span class="ident">try_recv_from</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>((<span class="ident">n</span>, <span class="ident">_addr</span>)) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">n</span>]);
|
||
|
|
<span class="kw">break</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">continue</span>;
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.peek_from" class="method"><code>pub async fn <a href="#method.peek_from" class="fnname">peek_from</a><'_, '_>(<br> &'_ self, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'_ mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#972-977" title="goto source code">[src]</a></h4><div class="docblock"><p>Receives data from the socket, without removing it from the input queue.
|
||
|
|
On success, returns the number of bytes read and the address from whence
|
||
|
|
the data came.</p>
|
||
|
|
<h1 id="notes" class="section-header"><a href="#notes">Notes</a></h1>
|
||
|
|
<p>On Windows, if the data is larger than the buffer specified, the buffer
|
||
|
|
is filled with the first part of the data, and peek_from returns the error
|
||
|
|
WSAEMSGSIZE(10040). The excess data is lost.
|
||
|
|
Make sure to always use a sufficiently large buffer to hold the
|
||
|
|
maximum UDP packet size, which can be up to 65536 bytes in size.</p>
|
||
|
|
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">0u8</span>; <span class="number">32</span>];
|
||
|
|
<span class="kw">let</span> (<span class="ident">len</span>, <span class="ident">addr</span>) <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">peek_from</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buf</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"peeked {:?} bytes from {:?}"</span>, <span class="ident">len</span>, <span class="ident">addr</span>);
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id="method.poll_peek_from" class="method"><code>pub fn <a href="#method.poll_peek_from" class="fnname">poll_peek_from</a>(<br> &self, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: &mut <a class="struct" href="../../tokio/io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1005-1025" title="goto source code">[src]</a></h4><div class="docblock"><p>Receives data from the socket, without removing it from the input queue.
|
||
|
|
On success, returns the number of bytes read.</p>
|
||
|
|
<h1 id="notes-1" class="section-header"><a href="#notes-1">Notes</a></h1>
|
||
|
|
<p>Note that on multiple calls to a <code>poll_*</code> method in the recv direction, only the
|
||
|
|
<code>Waker</code> from the <code>Context</code> passed to the most recent call will be scheduled to
|
||
|
|
receive a wakeup</p>
|
||
|
|
<p>On Windows, if the data is larger than the buffer specified, the buffer
|
||
|
|
is filled with the first part of the data, and peek returns the error
|
||
|
|
WSAEMSGSIZE(10040). The excess data is lost.
|
||
|
|
Make sure to always use a sufficiently large buffer to hold the
|
||
|
|
maximum UDP packet size, which can be up to 65536 bytes in size.</p>
|
||
|
|
<h1 id="return-value-4" class="section-header"><a href="#return-value-4">Return value</a></h1>
|
||
|
|
<p>The function returns:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Poll::Pending</code> if the socket is not ready to read</li>
|
||
|
|
<li><code>Poll::Ready(Ok(addr))</code> reads data from <code>addr</code> into <code>ReadBuf</code> if the socket is ready</li>
|
||
|
|
<li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li>
|
||
|
|
</ul>
|
||
|
|
<h1 id="errors-4" class="section-header"><a href="#errors-4">Errors</a></h1>
|
||
|
|
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
|
|
</div><h4 id="method.broadcast" class="method"><code>pub fn <a href="#method.broadcast" class="fnname">broadcast</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1032-1034" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the value of the <code>SO_BROADCAST</code> option for this socket.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.set_broadcast"><code>set_broadcast</code></a>.</p>
|
||
|
|
</div><h4 id="method.set_broadcast" class="method"><code>pub fn <a href="#method.set_broadcast" class="fnname">set_broadcast</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1040-1042" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value of the <code>SO_BROADCAST</code> option for this socket.</p>
|
||
|
|
<p>When enabled, this socket is allowed to send packets to a broadcast
|
||
|
|
address.</p>
|
||
|
|
</div><h4 id="method.multicast_loop_v4" class="method"><code>pub fn <a href="#method.multicast_loop_v4" class="fnname">multicast_loop_v4</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1049-1051" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the value of the <code>IP_MULTICAST_LOOP</code> option for this socket.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.set_multicast_loop_v4"><code>set_multicast_loop_v4</code></a>.</p>
|
||
|
|
</div><h4 id="method.set_multicast_loop_v4" class="method"><code>pub fn <a href="#method.set_multicast_loop_v4" class="fnname">set_multicast_loop_v4</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1060-1062" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value of the <code>IP_MULTICAST_LOOP</code> option for this socket.</p>
|
||
|
|
<p>If enabled, multicast packets will be looped back to the local socket.</p>
|
||
|
|
<h1 id="note" class="section-header"><a href="#note">Note</a></h1>
|
||
|
|
<p>This may not have any affect on IPv6 sockets.</p>
|
||
|
|
</div><h4 id="method.multicast_ttl_v4" class="method"><code>pub fn <a href="#method.multicast_ttl_v4" class="fnname">multicast_ttl_v4</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1069-1071" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the value of the <code>IP_MULTICAST_TTL</code> option for this socket.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.set_multicast_ttl_v4"><code>set_multicast_ttl_v4</code></a>.</p>
|
||
|
|
</div><h4 id="method.set_multicast_ttl_v4" class="method"><code>pub fn <a href="#method.set_multicast_ttl_v4" class="fnname">set_multicast_ttl_v4</a>(&self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1082-1084" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value of the <code>IP_MULTICAST_TTL</code> option for this socket.</p>
|
||
|
|
<p>Indicates the time-to-live value of outgoing multicast packets for
|
||
|
|
this socket. The default value is 1 which means that multicast packets
|
||
|
|
don't leave the local network unless explicitly requested.</p>
|
||
|
|
<h1 id="note-1" class="section-header"><a href="#note-1">Note</a></h1>
|
||
|
|
<p>This may not have any affect on IPv6 sockets.</p>
|
||
|
|
</div><h4 id="method.multicast_loop_v6" class="method"><code>pub fn <a href="#method.multicast_loop_v6" class="fnname">multicast_loop_v6</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1091-1093" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the value of the <code>IPV6_MULTICAST_LOOP</code> option for this socket.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.set_multicast_loop_v6"><code>set_multicast_loop_v6</code></a>.</p>
|
||
|
|
</div><h4 id="method.set_multicast_loop_v6" class="method"><code>pub fn <a href="#method.set_multicast_loop_v6" class="fnname">set_multicast_loop_v6</a>(&self, on: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1102-1104" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value of the <code>IPV6_MULTICAST_LOOP</code> option for this socket.</p>
|
||
|
|
<p>Controls whether this socket sees the multicast packets it sends itself.</p>
|
||
|
|
<h1 id="note-2" class="section-header"><a href="#note-2">Note</a></h1>
|
||
|
|
<p>This may not have any affect on IPv4 sockets.</p>
|
||
|
|
</div><h4 id="method.ttl" class="method"><code>pub fn <a href="#method.ttl" class="fnname">ttl</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1125-1127" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the value of the <code>IP_TTL</code> option for this socket.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.set_ttl"><code>set_ttl</code></a>.</p>
|
||
|
|
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">sock</span>.<span class="ident">ttl</span>()<span class="question-mark">?</span>);</pre></div>
|
||
|
|
</div><h4 id="method.set_ttl" class="method"><code>pub fn <a href="#method.set_ttl" class="fnname">set_ttl</a>(&self, ttl: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1147-1149" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the value for the <code>IP_TTL</code> option on this socket.</p>
|
||
|
|
<p>This value sets the time-to-live field that is used in every packet sent
|
||
|
|
from this socket.</p>
|
||
|
|
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">sock</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
<span class="ident">sock</span>.<span class="ident">set_ttl</span>(<span class="number">60</span>)<span class="question-mark">?</span>;
|
||
|
|
</pre></div>
|
||
|
|
</div><h4 id="method.join_multicast_v4" class="method"><code>pub fn <a href="#method.join_multicast_v4" class="fnname">join_multicast_v4</a>(<br> &self, <br> multiaddr: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>, <br> interface: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1158-1160" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes an operation of the <code>IP_ADD_MEMBERSHIP</code> type.</p>
|
||
|
|
<p>This function specifies a new multicast group for this socket to join.
|
||
|
|
The address must be a valid multicast address, and <code>interface</code> is the
|
||
|
|
address of the local interface with which the system should join the
|
||
|
|
multicast group. If it's equal to <code>INADDR_ANY</code> then an appropriate
|
||
|
|
interface is chosen by the system.</p>
|
||
|
|
</div><h4 id="method.join_multicast_v6" class="method"><code>pub fn <a href="#method.join_multicast_v6" class="fnname">join_multicast_v6</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1167-1169" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes an operation of the <code>IPV6_ADD_MEMBERSHIP</code> type.</p>
|
||
|
|
<p>This function specifies a new multicast group for this socket to join.
|
||
|
|
The address must be a valid multicast address, and <code>interface</code> is the
|
||
|
|
index of the interface to join/leave (or 0 to indicate any interface).</p>
|
||
|
|
</div><h4 id="method.leave_multicast_v4" class="method"><code>pub fn <a href="#method.leave_multicast_v4" class="fnname">leave_multicast_v4</a>(<br> &self, <br> multiaddr: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>, <br> interface: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1176-1178" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes an operation of the <code>IP_DROP_MEMBERSHIP</code> type.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.join_multicast_v4"><code>join_multicast_v4</code></a>.</p>
|
||
|
|
</div><h4 id="method.leave_multicast_v6" class="method"><code>pub fn <a href="#method.leave_multicast_v6" class="fnname">leave_multicast_v6</a>(<br> &self, <br> multiaddr: &<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>, <br> interface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1185-1187" title="goto source code">[src]</a></h4><div class="docblock"><p>Executes an operation of the <code>IPV6_DROP_MEMBERSHIP</code> type.</p>
|
||
|
|
<p>For more information about this option, see <a href="../../tokio/net/struct.UdpSocket.html#method.join_multicast_v6"><code>join_multicast_v6</code></a>.</p>
|
||
|
|
</div><h4 id="method.take_error" class="method"><code>pub fn <a href="#method.take_error" class="fnname">take_error</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1208-1210" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the value of the <code>SO_ERROR</code> option.</p>
|
||
|
|
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
||
|
|
|
||
|
|
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
|
|
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
|
|
<span class="comment">// Create a socket</span>
|
||
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="string">"0.0.0.0:8080"</span>).<span class="ident">await</span><span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="ident">err</span>)) <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">take_error</span>() {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Got error: {:?}"</span>, <span class="ident">err</span>);
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</pre></div>
|
||
|
|
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-AsRawFd" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html" title="trait std::sys::unix::ext::io::AsRawFd">AsRawFd</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-AsRawFd" class="anchor"></a><a class="srclink" href="../../src/tokio/net/udp.rs.html#1236-1240" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.as_raw_fd" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd" class="fnname">as_raw_fd</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1237-1239" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></p>
|
||
|
|
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tokio/net/udp.rs.html#1225-1229" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1226-1228" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
|
|
</div></div><h3 id="impl-TryFrom%3CUdpSocket%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a>> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-TryFrom%3CUdpSocket%3E" class="anchor"></a><a class="srclink" href="../../src/tokio/net/udp.rs.html#1213-1223" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id="method.try_from" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(stream: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/udp/struct.UdpSocket.html" title="struct std::net::udp::UdpSocket">UdpSocket</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="../../src/tokio/net/udp.rs.html#1220-1222" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes stream, returning the tokio I/O object.</p>
|
||
|
|
<p>This is equivalent to
|
||
|
|
<a href="../../tokio/net/struct.UdpSocket.html#method.from_std"><code>UdpSocket::from_std(stream)</code></a>.</p>
|
||
|
|
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-Send" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-Sync" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-Unpin" class="anchor"></a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../tokio/net/struct.UdpSocket.html" title="struct tokio::net::UdpSocket">UdpSocket</a></code><a href="#impl-UnwindSafe" class="anchor"></a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
|
|
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210-214" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T<span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211-213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
|
|
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217-221" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T<span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<div class="notable-traits-tooltiptext"><span class="docblock"><h3 class="notable">Notable traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="type">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;</span></code></span></div></span></span></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
|
|
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#552-556" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#553-555" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541-548" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-547" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589-598" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id="method.try_from-1" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#595-597" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#575-584" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-2" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-583" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tokio";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|