|
|
<!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 `mio`."><meta name="keywords" content="rust, rustlang, rust-lang, UdpSocket"><title>mio::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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><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='../../mio/index.html'><div class='logo-container'><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="#methods">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_socket">from_socket</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.only_v6">only_v6</a><a href="#method.recv">recv</a><a href="#method.recv_bufs">recv_bufs</a><a href="#method.recv_from">recv_from</a><a href="#method.send">send</a><a href="#method.send_bufs">send_bufs</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_only_v6">set_only_v6</a><a href="#method.set_ttl">set_ttl</a><a href="#method.take_error">take_error</a><a href="#method.try_clone">try_clone</a><a href="#method.ttl">ttl</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-AsRawFd">AsRawFd</a><a href="#impl-Debug">Debug</a><a href="#impl-Evented">Evented</a><a href="#impl-FromRawFd">FromRawFd</a><a href="#impl-IntoRawFd">IntoRawFd</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'>mio</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!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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/mio/net/udp.rs.html#92-95' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>mio</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 User Datagram Protocol socket.</p>
|
|
|
<p>This is an implementation of a bound UDP socket. This supports both IPv4 and
|
|
|
IPv6 addresses, and there is no corresponding notion of a server because UDP
|
|
|
is a datagram protocol.</p>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="comment">// An Echo program:</span>
|
|
|
<span class="comment">// SENDER -> sends a message.</span>
|
|
|
<span class="comment">// ECHOER -> listens and prints the message received.</span>
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
|
|
<span class="kw">use</span> <span class="ident">mio</span>::{<span class="ident">Events</span>, <span class="ident">Ready</span>, <span class="ident">Poll</span>, <span class="ident">PollOpt</span>, <span class="ident">Token</span>};
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
|
|
|
|
|
<span class="kw">const</span> <span class="ident">SENDER</span>: <span class="ident">Token</span> <span class="op">=</span> <span class="ident">Token</span>(<span class="number">0</span>);
|
|
|
<span class="kw">const</span> <span class="ident">ECHOER</span>: <span class="ident">Token</span> <span class="op">=</span> <span class="ident">Token</span>(<span class="number">1</span>);
|
|
|
|
|
|
<span class="comment">// This operation will fail if the address is in use, so we select different ports for each</span>
|
|
|
<span class="comment">// socket.</span>
|
|
|
<span class="kw">let</span> <span class="ident">sender_socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="kw">let</span> <span class="ident">echoer_socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="comment">// If we do not use connect here, SENDER and ECHOER would need to call send_to and recv_from</span>
|
|
|
<span class="comment">// respectively.</span>
|
|
|
<span class="ident">sender_socket</span>.<span class="ident">connect</span>(<span class="ident">echoer_socket</span>.<span class="ident">local_addr</span>().<span class="ident">unwrap</span>())<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="comment">// We need a Poll to check if SENDER is ready to be written into, and if ECHOER is ready to be</span>
|
|
|
<span class="comment">// read from.</span>
|
|
|
<span class="kw">let</span> <span class="ident">poll</span> <span class="op">=</span> <span class="ident">Poll</span>::<span class="ident">new</span>()<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="comment">// We register our sockets here so that we can check if they are ready to be written/read.</span>
|
|
|
<span class="ident">poll</span>.<span class="ident">register</span>(<span class="kw-2">&</span><span class="ident">sender_socket</span>, <span class="ident">SENDER</span>, <span class="ident">Ready</span>::<span class="ident">writable</span>(), <span class="ident">PollOpt</span>::<span class="ident">edge</span>())<span class="question-mark">?</span>;
|
|
|
<span class="ident">poll</span>.<span class="ident">register</span>(<span class="kw-2">&</span><span class="ident">echoer_socket</span>, <span class="ident">ECHOER</span>, <span class="ident">Ready</span>::<span class="ident">readable</span>(), <span class="ident">PollOpt</span>::<span class="ident">edge</span>())<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">msg_to_send</span> <span class="op">=</span> [<span class="number">9</span>; <span class="number">9</span>];
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">9</span>];
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">events</span> <span class="op">=</span> <span class="ident">Events</span>::<span class="ident">with_capacity</span>(<span class="number">128</span>);
|
|
|
<span class="kw">loop</span> {
|
|
|
<span class="ident">poll</span>.<span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">events</span>, <span class="prelude-val">Some</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">100</span>)))<span class="question-mark">?</span>;
|
|
|
<span class="kw">for</span> <span class="ident">event</span> <span class="kw">in</span> <span class="ident">events</span>.<span class="ident">iter</span>() {
|
|
|
<span class="kw">match</span> <span class="ident">event</span>.<span class="ident">token</span>() {
|
|
|
<span class="comment">// Our SENDER is ready to be written into.</span>
|
|
|
<span class="ident">SENDER</span> <span class="op">=</span><span class="op">></span> {
|
|
|
<span class="kw">let</span> <span class="ident">bytes_sent</span> <span class="op">=</span> <span class="ident">sender_socket</span>.<span class="ident">send</span>(<span class="kw-2">&</span><span class="ident">msg_to_send</span>)<span class="question-mark">?</span>;
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bytes_sent</span>, <span class="number">9</span>);
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"sent {:?} -> {:?} bytes"</span>, <span class="ident">msg_to_send</span>, <span class="ident">bytes_sent</span>);
|
|
|
},
|
|
|
<span class="comment">// Our ECHOER is ready to be read from.</span>
|
|
|
<span class="ident">ECHOER</span> <span class="op">=</span><span class="op">></span> {
|
|
|
<span class="kw">let</span> <span class="ident">num_recv</span> <span class="op">=</span> <span class="ident">echoer_socket</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">buffer</span>)<span class="question-mark">?</span>;
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"echo {:?} -> {:?}"</span>, <span class="ident">buffer</span>, <span class="ident">num_recv</span>);
|
|
|
<span class="ident">buffer</span> <span class="op">=</span> [<span class="number">0</span>; <span class="number">9</span>];
|
|
|
}
|
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>()
|
|
|
}
|
|
|
}
|
|
|
}</pre></div>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#97-590' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.bind' class="method"><code id='bind.v'>pub fn <a href='#method.bind' class='fnname'>bind</a>(addr: &<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="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a>></code><a class='srclink' href='../../src/mio/net/udp.rs.html#125-128' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a UDP socket from the given address.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
|
|
|
|
|
<span class="comment">// We must bind it to an open address.</span>
|
|
|
<span class="kw">let</span> <span class="ident">socket</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>) {
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">new_socket</span>) <span class="op">=</span><span class="op">></span> <span class="ident">new_socket</span>,
|
|
|
<span class="prelude-val">Err</span>(<span class="ident">fail</span>) <span class="op">=</span><span class="op">></span> {
|
|
|
<span class="comment">// We panic! here, but you could try to bind it again on another address.</span>
|
|
|
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Failed to bind socket. {:?}"</span>, <span class="ident">fail</span>);
|
|
|
}
|
|
|
};
|
|
|
|
|
|
<span class="comment">// Our socket was created, but we should not use it before checking it's readiness.</span></pre></div>
|
|
|
</div><h4 id='method.from_socket' class="method"><code id='from_socket.v'>pub fn <a href='#method.from_socket' class='fnname'>from_socket</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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a>></code><a class='srclink' href='../../src/mio/net/udp.rs.html#140-145' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new mio-wrapped socket from an underlying and bound std
|
|
|
socket.</p>
|
|
|
<p>This function requires that <code>socket</code> has previously been bound to an
|
|
|
address to work correctly, and returns an I/O object which can be used
|
|
|
with mio to send/receive UDP messages.</p>
|
|
|
<p>This can be used in conjunction with net2's <code>UdpBuilder</code> interface to
|
|
|
configure a socket before it's handed off to mio, such as setting
|
|
|
options like <code>reuse_address</code> or binding to multiple addresses.</p>
|
|
|
</div><h4 id='method.local_addr' class="method"><code id='local_addr.v'>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/mio/net/udp.rs.html#170-172' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the socket address that this socket was created from.</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">mio</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">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</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="kw-2">&</span><span class="ident">addr</span>)<span class="question-mark">?</span>;</pre></div>
|
|
|
</div><h4 id='method.try_clone' class="method"><code id='try_clone.v'>pub fn <a href='#method.try_clone' class='fnname'>try_clone</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="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a>></code><a class='srclink' href='../../src/mio/net/udp.rs.html#201-209' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new independently owned handle to the underlying socket.</p>
|
|
|
<p>The returned <code>UdpSocket</code> is a reference to the same socket that this
|
|
|
object references. Both handles will read and write the same port, and
|
|
|
options set on one socket will be propagated to the other.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
|
|
|
|
|
<span class="comment">// We must bind it to an open address.</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="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="kw">let</span> <span class="ident">cloned_socket</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">try_clone</span>()<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">socket</span>.<span class="ident">local_addr</span>()<span class="question-mark">?</span>, <span class="ident">cloned_socket</span>.<span class="ident">local_addr</span>()<span class="question-mark">?</span>);
|
|
|
</pre></div>
|
|
|
</div><h4 id='method.send_to' class="method"><code id='send_to.v'>pub fn <a href='#method.send_to' class='fnname'>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/mio/net/udp.rs.html#239-241' 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 <code>ToSocketAddrs</code> trait. See its
|
|
|
documentation for concrete examples.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</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="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="comment">// We must check if the socket is writable before calling send_to,</span>
|
|
|
<span class="comment">// or we could run into a WouldBlock error.</span>
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">bytes_sent</span> <span class="op">=</span> <span class="ident">socket</span>.<span class="ident">send_to</span>(<span class="kw-2">&</span>[<span class="number">9</span>; <span class="number">9</span>], <span class="kw-2">&</span><span class="string">"127.0.0.1:11100"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bytes_sent</span>, <span class="number">9</span>);</pre></div>
|
|
|
</div><h4 id='method.recv_from' class="method"><code id='recv_from.v'>pub fn <a href='#method.recv_from' class='fnname'>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/mio/net/udp.rs.html#270-272' title='goto source code'>[src]</a></h4><div class='docblock'><p>Receives data from the socket. On success, returns the number of bytes
|
|
|
read and the address from whence the data came.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</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="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="comment">// We must check if the socket is readable before calling recv_from,</span>
|
|
|
<span class="comment">// or we could run into a WouldBlock error.</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">9</span>];
|
|
|
<span class="kw">let</span> (<span class="ident">num_recv</span>, <span class="ident">from_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="question-mark">?</span>;
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Received {:?} -> {:?} bytes from {:?}"</span>, <span class="ident">buf</span>, <span class="ident">num_recv</span>, <span class="ident">from_addr</span>);</pre></div>
|
|
|
</div><h4 id='method.send' class="method"><code id='send.v'>pub 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/mio/net/udp.rs.html#276-278' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sends data on the socket to the address previously bound via connect(). On success,
|
|
|
returns the number of bytes written.</p>
|
|
|
</div><h4 id='method.recv' class="method"><code id='recv.v'>pub 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/mio/net/udp.rs.html#282-284' title='goto source code'>[src]</a></h4><div class='docblock'><p>Receives data from the socket previously bound with connect(). On success, returns
|
|
|
the number of bytes read.</p>
|
|
|
</div><h4 id='method.connect' class="method"><code id='connect.v'>pub fn <a href='#method.connect' class='fnname'>connect</a>(&self, addr: <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.unit.html">()</a>></code><a class='srclink' href='../../src/mio/net/udp.rs.html#289-291' title='goto source code'>[src]</a></h4><div class='docblock'><p>Connects the UDP socket setting the default destination for <code>send()</code>
|
|
|
and limiting packets that are read via <code>recv</code> from the address specified
|
|
|
in <code>addr</code>.</p>
|
|
|
</div><h4 id='method.set_broadcast' class="method"><code id='set_broadcast.v'>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/mio/net/udp.rs.html#320-322' 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>
|
|
|
<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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">broadcast_socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="kw">if</span> <span class="ident">broadcast_socket</span>.<span class="ident">broadcast</span>()<span class="question-mark">?</span> <span class="op">=</span><span class="op">=</span> <span class="bool-val">false</span> {
|
|
|
<span class="ident">broadcast_socket</span>.<span class="ident">set_broadcast</span>(<span class="bool-val">true</span>)<span class="question-mark">?</span>;
|
|
|
}
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">broadcast_socket</span>.<span class="ident">broadcast</span>()<span class="question-mark">?</span>, <span class="bool-val">true</span>);</pre></div>
|
|
|
</div><h4 id='method.broadcast' class="method"><code id='broadcast.v'>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/mio/net/udp.rs.html#349-351' 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="#method.set_broadcast"><code>set_broadcast</code></a>.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">broadcast_socket</span> <span class="op">=</span> <span class="ident">UdpSocket</span>::<span class="ident">bind</span>(<span class="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">broadcast_socket</span>.<span class="ident">broadcast</span>()<span class="question-mark">?</span>, <span class="bool-val">false</span>);</pre></div>
|
|
|
</div><h4 id='method.set_multicast_loop_v4' class="method"><code id='set_multicast_loop_v4.v'>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/mio/net/udp.rs.html#357-359' 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.
|
|
|
Note that this may not have any affect on IPv6 sockets.</p>
|
|
|
</div><h4 id='method.multicast_loop_v4' class="method"><code id='multicast_loop_v4.v'>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/mio/net/udp.rs.html#367-369' 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="#method.set_multicast_loop_v4"><code>set_multicast_loop_v4</code></a>.</p>
|
|
|
</div><h4 id='method.set_multicast_ttl_v4' class="method"><code id='set_multicast_ttl_v4.v'>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/mio/net/udp.rs.html#378-380' 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>
|
|
|
<p>Note that this may not have any affect on IPv6 sockets.</p>
|
|
|
</div><h4 id='method.multicast_ttl_v4' class="method"><code id='multicast_ttl_v4.v'>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/mio/net/udp.rs.html#388-390' 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="#method.set_multicast_ttl_v4"><code>set_multicast_ttl_v4</code></a>.</p>
|
|
|
</div><h4 id='method.set_multicast_loop_v6' class="method"><code id='set_multicast_loop_v6.v'>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/mio/net/udp.rs.html#396-398' 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.
|
|
|
Note that this may not have any affect on IPv4 sockets.</p>
|
|
|
</div><h4 id='method.multicast_loop_v6' class="method"><code id='multicast_loop_v6.v'>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/mio/net/udp.rs.html#406-408' 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="#method.set_multicast_loop_v6"><code>set_multicast_loop_v6</code></a>.</p>
|
|
|
</div><h4 id='method.set_ttl' class="method"><code id='set_ttl.v'>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/mio/net/udp.rs.html#437-439' 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-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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</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="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="kw">if</span> <span class="ident">socket</span>.<span class="ident">ttl</span>()<span class="question-mark">?</span> <span class="op"><</span> <span class="number">255</span> {
|
|
|
<span class="ident">socket</span>.<span class="ident">set_ttl</span>(<span class="number">255</span>)<span class="question-mark">?</span>;
|
|
|
}
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">socket</span>.<span class="ident">ttl</span>()<span class="question-mark">?</span>, <span class="number">255</span>);</pre></div>
|
|
|
</div><h4 id='method.ttl' class="method"><code id='ttl.v'>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/mio/net/udp.rs.html#467-469' 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="#method.set_ttl"><code>set_ttl</code></a>.</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">mio</span>::<span class="ident">net</span>::<span class="ident">UdpSocket</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="kw-2">&</span><span class="string">"127.0.0.1:0"</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
|
|
<span class="ident">socket</span>.<span class="ident">set_ttl</span>(<span class="number">255</span>)<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">socket</span>.<span class="ident">ttl</span>()<span class="question-mark">?</span>, <span class="number">255</span>);</pre></div>
|
|
|
</div><h4 id='method.join_multicast_v4' class="method"><code id='join_multicast_v4.v'>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/mio/net/udp.rs.html#478-482' 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 id='join_multicast_v6.v'>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/mio/net/udp.rs.html#489-493' 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 id='leave_multicast_v4.v'>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/mio/net/udp.rs.html#501-505' 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="#method.join_multicast_v4"><code>join_multicast_v4</code></a>.</p>
|
|
|
</div><h4 id='method.leave_multicast_v6' class="method"><code id='leave_multicast_v6.v'>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/mio/net/udp.rs.html#513-517' 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="#method.join_multicast_v6"><code>join_multicast_v6</code></a>.</p>
|
|
|
</div><h4 id='method.set_only_v6' class="method"><code id='set_only_v6.v'>pub fn <a href='#method.set_only_v6' class='fnname'>set_only_v6</a>(&self, only_v6: <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/mio/net/udp.rs.html#527-529' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the value for the <code>IPV6_V6ONLY</code> option on this socket.</p>
|
|
|
<p>If this is set to <code>true</code> then the socket is restricted to sending and
|
|
|
receiving IPv6 packets only. In this case two IPv4 and IPv6 applications
|
|
|
can bind the same port at the same time.</p>
|
|
|
<p>If this is set to <code>false</code> then the socket can be used to send and
|
|
|
receive packets from an IPv4-mapped IPv6 address.</p>
|
|
|
</div><h4 id='method.only_v6' class="method"><code id='only_v6.v'>pub fn <a href='#method.only_v6' class='fnname'>only_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/mio/net/udp.rs.html#536-538' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gets the value of the <code>IPV6_V6ONLY</code> option for this socket.</p>
|
|
|
<p>For more information about this option, see <a href="#method.set_only_v6"><code>set_only_v6</code></a>.</p>
|
|
|
</div><h4 id='method.take_error' class="method"><code id='take_error.v'>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/mio/net/udp.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the value of the <code>SO_ERROR</code> option on this socket.</p>
|
|
|
<p>This will retrieve the stored error in the underlying socket, clearing
|
|
|
the field in the process. This can be useful for checking errors between
|
|
|
calls.</p>
|
|
|
</div><h4 id='method.recv_bufs' class="method"><code id='recv_bufs.v'>pub fn <a href='#method.recv_bufs' class='fnname'>recv_bufs</a>(&self, bufs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>&mut <a class="struct" href="../../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</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/mio/net/udp.rs.html#566-568' title='goto source code'>[src]</a></h4><div class='docblock'><p>Receives a single datagram message socket previously bound with connect.</p>
|
|
|
<p>This operation will attempt to read bytes from this socket and place
|
|
|
them into the list of buffers provided. Note that each buffer is an
|
|
|
<code>IoVec</code> which can be created from a byte slice.</p>
|
|
|
<p>The buffers provided will be filled sequentially. A buffer will be
|
|
|
entirely filled up before the next is written to.</p>
|
|
|
<p>The number of bytes read is returned, if successful, or an error is
|
|
|
returned otherwise. If no bytes are available to be read yet then
|
|
|
a <a href="https://doc.rust-lang.org/nightly/std/io/enum.ErrorKind.html#variant.WouldBlock"><code>WouldBlock</code></a> error is returned. This operation does not block.</p>
|
|
|
<p>On Unix this corresponds to the <code>readv</code> syscall.</p>
|
|
|
</div><h4 id='method.send_bufs' class="method"><code id='send_bufs.v'>pub fn <a href='#method.send_bufs' class='fnname'>send_bufs</a>(&self, bufs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>&<a class="struct" href="../../iovec/struct.IoVec.html" title="struct iovec::IoVec">IoVec</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/mio/net/udp.rs.html#587-589' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sends data on the socket to the address previously bound via connect.</p>
|
|
|
<p>This operation will attempt to send a list of byte buffers to this
|
|
|
socket in a single datagram. Note that each buffer is an <code>IoVec</code>
|
|
|
which can be created from a byte slice.</p>
|
|
|
<p>The buffers provided will be written sequentially. A buffer will be
|
|
|
entirely written before the next is written.</p>
|
|
|
<p>The number of bytes written is returned, if successful, or an error is
|
|
|
returned otherwise. If the socket is not currently writable then a
|
|
|
<a href="https://doc.rust-lang.org/nightly/std/io/enum.ErrorKind.html#variant.WouldBlock"><code>WouldBlock</code></a> error is returned. This operation does not block.</p>
|
|
|
<p>On Unix this corresponds to the <code>writev</code> syscall.</p>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Evented' class='impl'><code class='in-band'>impl <a class="trait" href="../../mio/event/trait.Evented.html" title="trait mio::event::Evented">Evented</a> for <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-Evented' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#592-605' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.register' class="method hidden"><code id='register.v'>fn <a href='../../mio/event/trait.Evented.html#tymethod.register' class='fnname'>register</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</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/mio/net/udp.rs.html#593-596' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Register <code>self</code> with the given <code>Poll</code> instance. <a href="../../mio/event/trait.Evented.html#tymethod.register">Read more</a></p>
|
|
|
</div><h4 id='method.reregister' class="method hidden"><code id='reregister.v'>fn <a href='../../mio/event/trait.Evented.html#tymethod.reregister' class='fnname'>reregister</a>(<br> &self, <br> poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::Poll">Poll</a>, <br> token: <a class="struct" href="../../mio/struct.Token.html" title="struct mio::Token">Token</a>, <br> interest: <a class="struct" href="../../mio/struct.Ready.html" title="struct mio::Ready">Ready</a>, <br> opts: <a class="struct" href="../../mio/struct.PollOpt.html" title="struct mio::PollOpt">PollOpt</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/mio/net/udp.rs.html#598-600' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Re-register <code>self</code> with the given <code>Poll</code> instance. <a href="../../mio/event/trait.Evented.html#tymethod.reregister">Read more</a></p>
|
|
|
</div><h4 id='method.deregister' class="method hidden"><code id='deregister.v'>fn <a href='../../mio/event/trait.Evented.html#tymethod.deregister' class='fnname'>deregister</a>(&self, poll: &<a class="struct" href="../../mio/struct.Poll.html" title="struct mio::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/mio/net/udp.rs.html#602-604' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Deregister <code>self</code> from the given <code>Poll</code> instance <a href="../../mio/event/trait.Evented.html#tymethod.deregister">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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#607-611' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>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/mio/net/udp.rs.html#608-610' 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-IntoRawFd' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.IntoRawFd.html" title="trait std::sys::unix::ext::io::IntoRawFd">IntoRawFd</a> for <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-IntoRawFd' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#623-627' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into_raw_fd' class="method hidden"><code id='into_raw_fd.v'>fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.IntoRawFd.html#tymethod.into_raw_fd' class='fnname'>into_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/mio/net/udp.rs.html#624-626' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Consumes this object, returning the raw underlying file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.IntoRawFd.html#tymethod.into_raw_fd">Read more</a></p>
|
|
|
</div></div><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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-AsRawFd' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#630-634' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.as_raw_fd' class="method hidden"><code id='as_raw_fd.v'>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/mio/net/udp.rs.html#631-633' 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-FromRawFd' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html" title="trait std::sys::unix::ext::io::FromRawFd">FromRawFd</a> for <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-FromRawFd' class='anchor'></a><a class='srclink' href='../../src/mio/net/udp.rs.html#637-644' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_raw_fd' class="method hidden"><code id='from_raw_fd.v'>unsafe fn <a href='https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html#tymethod.from_raw_fd' class='fnname'>from_raw_fd</a>(fd: <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>) -> <a class="struct" href="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a class='srclink' href='../../src/mio/net/udp.rs.html#638-643' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Constructs a new instance of <code>Self</code> from the given raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/trait.FromRawFd.html#tymethod.from_raw_fd">Read more</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-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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-Send' 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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-Unpin' 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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-Sync' 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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><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="../../mio/net/struct.UdpSocket.html" title="struct mio::net::UdpSocket">UdpSocket</a></code><a href='#impl-RefUnwindSafe' 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-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.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>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.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>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.rs.html#554' 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.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>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' class="method hidden"><code id='try_from.v'>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.rs.html#575-577' 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.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>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 id='try_into.v'>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.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W</h3><code class="content"><span class="where fmt-newline">impl<'_, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</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">impl<'_, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</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></code></div></div><code id='borrow_mut.v'>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</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' 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-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#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W</h3><code class="content"><span class="where fmt-newline">impl<'_, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</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">impl<'_, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'_ mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</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></code></div></div><code id='borrow.v'>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</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' 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-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#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>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#101' 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></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "mio";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
