| <!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="An I/O object representing a Unix datagram socket."><meta name="keywords" content="rust, rustlang, rust-lang, UnixDatagram"><title>UnixDatagram in tokio::net - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">UnixDatagram</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.bind">bind</a></li><li><a href="#method.connect">connect</a></li><li><a href="#method.from_std">from_std</a></li><li><a href="#method.into_std">into_std</a></li><li><a href="#method.local_addr">local_addr</a></li><li><a href="#method.pair">pair</a></li><li><a href="#method.peer_addr">peer_addr</a></li><li><a href="#method.poll_recv">poll_recv</a></li><li><a href="#method.poll_recv_from">poll_recv_from</a></li><li><a href="#method.poll_recv_ready">poll_recv_ready</a></li><li><a href="#method.poll_send">poll_send</a></li><li><a href="#method.poll_send_ready">poll_send_ready</a></li><li><a href="#method.poll_send_to">poll_send_to</a></li><li><a href="#method.readable">readable</a></li><li><a href="#method.ready">ready</a></li><li><a href="#method.recv">recv</a></li><li><a href="#method.recv_from">recv_from</a></li><li><a href="#method.send">send</a></li><li><a href="#method.send_to">send_to</a></li><li><a href="#method.shutdown">shutdown</a></li><li><a href="#method.take_error">take_error</a></li><li><a href="#method.try_io">try_io</a></li><li><a href="#method.try_recv">try_recv</a></li><li><a href="#method.try_recv_buf">try_recv_buf</a></li><li><a href="#method.try_recv_buf_from">try_recv_buf_from</a></li><li><a href="#method.try_recv_from">try_recv_from</a></li><li><a href="#method.try_send">try_send</a></li><li><a href="#method.try_send_to">try_send_to</a></li><li><a href="#method.unbound">unbound</a></li><li><a href="#method.writable">writable</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsRawFd-for-UnixDatagram">AsRawFd</a></li><li><a href="#impl-Debug-for-UnixDatagram">Debug</a></li><li><a href="#impl-TryFrom%3CUnixDatagram%3E-for-UnixDatagram">TryFrom<UnixDatagram></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-UnixDatagram">RefUnwindSafe</a></li><li><a href="#impl-Send-for-UnixDatagram">Send</a></li><li><a href="#impl-Sync-for-UnixDatagram">Sync</a></li><li><a href="#impl-Unpin-for-UnixDatagram">Unpin</a></li><li><a href="#impl-UnwindSafe-for-UnixDatagram">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-UnixDatagram">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-UnixDatagram">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-UnixDatagram">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-UnixDatagram">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-UnixDatagram">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-UnixDatagram">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-UnixDatagram">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::net</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">net</a>::<wbr><a class="struct" href="#">UnixDatagram</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio/net/unix/datagram/socket.rs.html#93-95">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct UnixDatagram { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An I/O object representing a Unix datagram socket.</p> |
| <p>A socket can be either named (associated with a filesystem path) or |
| unnamed.</p> |
| <p>This type does not provide a <code>split</code> method, because this functionality |
| can be achieved by wrapping the socket in an <a href="std::sync::Arc"><code>Arc</code></a>. Note that you do |
| not need a <code>Mutex</code> to share the <code>UnixDatagram</code> — an <code>Arc<UnixDatagram></code> |
| is enough. This is because all of the methods take <code>&self</code> instead of |
| <code>&mut self</code>.</p> |
| <p><strong>Note:</strong> named sockets are persisted even after the object is dropped |
| and the program has exited, and cannot be reconnected. It is advised |
| that you either check for and unlink the existing socket if it exists, |
| or use a temporary file that is guaranteed to not already exist.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Using named sockets, associated with a filesystem path:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind each socket to a filesystem path |
| </span><span class="kw">let </span>tx_path = tmp.path().join(<span class="string">"tx"</span>); |
| <span class="kw">let </span>tx = UnixDatagram::bind(<span class="kw-2">&</span>tx_path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| tx.send_to(bytes, <span class="kw-2">&</span>rx_path).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>(size, addr) = rx.recv_from(<span class="kw-2">&mut </span>buf).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buf[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| <span class="macro">assert_eq!</span>(addr.as_pathname().unwrap(), <span class="kw-2">&</span>tx_path); |
| </code></pre></div> |
| <p>Using unnamed sockets, created as a pair</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create the pair of sockets |
| </span><span class="kw">let </span>(sock1, sock2) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Since the sockets are paired, the paired send/recv |
| // functions can be used |
| </span><span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| sock1.send(bytes).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buff = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>size = sock2.recv(<span class="kw-2">&mut </span>buff).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buff[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-UnixDatagram" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#98-1409">source</a><a href="#impl-UnixDatagram" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ready" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#169-172">source</a><h4 class="code-header">pub async fn <a href="#method.ready" class="fnname">ready</a>(&self, interest: <a class="struct" href="../io/struct.Interest.html" title="struct tokio::io::Interest">Interest</a>) -> Result<<a class="struct" href="../io/struct.Ready.html" title="struct tokio::io::Ready">Ready</a>></h4></section></summary><div class="docblock"><p>Waits 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>. The function can also return with an empty |
| <a href="../io/struct.Ready.html" title="Ready"><code>Ready</code></a> set, so you should always check the returned value and possibly |
| wait again if the requested states are not set.</p> |
| <h5 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h5> |
| <p>This method is cancel safe. Once a readiness event occurs, the method |
| will continue to return immediately until the readiness event is |
| consumed by an attempt to read or write that fails with <code>WouldBlock</code> or |
| <code>Poll::Pending</code>.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <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"><code><span class="kw">use </span>tokio::io::Interest; |
| <span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span>ready = socket.ready(Interest::READABLE | Interest::WRITABLE).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">if </span>ready.is_readable() { |
| <span class="kw">let </span><span class="kw-2">mut </span>data = [<span class="number">0</span>; <span class="number">1024</span>]; |
| <span class="kw">match </span>socket.try_recv(<span class="kw-2">&mut </span>data[..]) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"received {:?}"</span>, <span class="kw-2">&</span>data[..n]); |
| } |
| <span class="comment">// False-positive, continue |
| </span><span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => {} |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="kw">if </span>ready.is_writable() { |
| <span class="comment">// Write some data |
| </span><span class="kw">match </span>socket.try_send(<span class="string">b"hello world"</span>) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"sent {} bytes"</span>, n); |
| } |
| <span class="comment">// False-positive, continue |
| </span><span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => {} |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.writable" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#226-229">source</a><h4 class="code-header">pub async fn <a href="#method.writable" class="fnname">writable</a>(&self) -> Result<()></h4></section></summary><div class="docblock"><p>Waits 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> |
| <h5 id="cancel-safety-1"><a href="#cancel-safety-1">Cancel safety</a></h5> |
| <p>This method is cancel safe. Once a readiness event occurs, the method |
| will continue to return immediately until the readiness event is |
| consumed by an attempt to write that fails with <code>WouldBlock</code> or |
| <code>Poll::Pending</code>.</p> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be writable |
| </span>socket.writable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to send data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_send(<span class="string">b"hello world"</span>) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_send_ready" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#260-262">source</a><h4 class="code-header">pub fn <a href="#method.poll_send_ready" class="fnname">poll_send_ready</a>(&self, cx: &mut Context<'_>) -> Poll<Result<()>></h4></section></summary><div class="docblock"><p>Polls for write/send readiness.</p> |
| <p>If the socket is not currently ready for sending, this method will |
| store a clone of the <code>Waker</code> from the provided <code>Context</code>. When the socket |
| becomes ready for sending, <code>Waker::wake</code> will be called on the |
| waker.</p> |
| <p>Note that on multiple calls to <code>poll_send_ready</code> or <code>poll_send</code>, only |
| the <code>Waker</code> from the <code>Context</code> passed to the most recent call is |
| scheduled to receive a wakeup. (However, <code>poll_recv_ready</code> retains a |
| second, independent waker.)</p> |
| <p>This function is intended for cases where creating and pinning a future |
| via <a href="struct.UnixDatagram.html#method.writable"><code>writable</code></a> is not feasible. Where possible, using <a href="struct.UnixDatagram.html#method.writable"><code>writable</code></a> is |
| preferred, as this supports polling from multiple tasks at once.</p> |
| <h5 id="return-value"><a href="#return-value">Return value</a></h5> |
| <p>The function returns:</p> |
| <ul> |
| <li><code>Poll::Pending</code> if the socket is not ready for writing.</li> |
| <li><code>Poll::Ready(Ok(()))</code> if the socket is ready for writing.</li> |
| <li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li> |
| </ul> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.readable" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#322-325">source</a><h4 class="code-header">pub async fn <a href="#method.readable" class="fnname">readable</a>(&self) -> Result<()></h4></section></summary><div class="docblock"><p>Waits 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> |
| <h5 id="cancel-safety-2"><a href="#cancel-safety-2">Cancel safety</a></h5> |
| <p>This method is cancel safe. Once a readiness event occurs, the method |
| will continue to return immediately until the readiness event is |
| consumed by an attempt to read that fails with <code>WouldBlock</code> or |
| <code>Poll::Pending</code>.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="comment">// Connect to a peer |
| </span><span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be readable |
| </span>socket.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// The buffer is **not** included in the async task and will |
| // only exist on the stack. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">1024</span>]; |
| |
| <span class="comment">// Try to recv data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_recv(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span>buf[..n]); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_recv_ready" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#356-358">source</a><h4 class="code-header">pub fn <a href="#method.poll_recv_ready" class="fnname">poll_recv_ready</a>(&self, cx: &mut Context<'_>) -> Poll<Result<()>></h4></section></summary><div class="docblock"><p>Polls for read/receive readiness.</p> |
| <p>If the socket is not currently ready for receiving, this method will |
| store a clone of the <code>Waker</code> from the provided <code>Context</code>. When the |
| socket becomes ready for reading, <code>Waker::wake</code> will be called on the |
| waker.</p> |
| <p>Note that on multiple calls to <code>poll_recv_ready</code>, <code>poll_recv</code> or |
| <code>poll_peek</code>, only the <code>Waker</code> from the <code>Context</code> passed to the most |
| recent call is scheduled to receive a wakeup. (However, |
| <code>poll_send_ready</code> retains a second, independent waker.)</p> |
| <p>This function is intended for cases where creating and pinning a future |
| via <a href="struct.UnixDatagram.html#method.readable"><code>readable</code></a> is not feasible. Where possible, using <a href="struct.UnixDatagram.html#method.readable"><code>readable</code></a> is |
| preferred, as this supports polling from multiple tasks at once.</p> |
| <h5 id="return-value-1"><a href="#return-value-1">Return value</a></h5> |
| <p>The function returns:</p> |
| <ul> |
| <li><code>Poll::Pending</code> if the socket is not ready for reading.</li> |
| <li><code>Poll::Ready(Ok(()))</code> if the socket is ready for reading.</li> |
| <li><code>Poll::Ready(Err(e))</code> if an error is encountered.</li> |
| </ul> |
| <h5 id="errors-1"><a href="#errors-1">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bind" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#381-387">source</a><h4 class="code-header">pub fn <a href="#method.bind" class="fnname">bind</a><P>(path: P) -> Result<<a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>><span class="where fmt-newline">where<br> P: AsRef<Path>,</span></h4></section></summary><div class="docblock"><p>Creates a new <code>UnixDatagram</code> bound to the specified path.</p> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind the socket to a filesystem path |
| </span><span class="kw">let </span>socket_path = tmp.path().join(<span class="string">"socket"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>socket_path)<span class="question-mark">?</span>; |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pair" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#418-424">source</a><h4 class="code-header">pub fn <a href="#method.pair" class="fnname">pair</a>() -> Result<(<a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>, <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>)></h4></section></summary><div class="docblock"><p>Creates an unnamed pair of connected sockets.</p> |
| <p>This function will create a pair of interconnected Unix sockets for |
| communicating back and forth between one another.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create the pair of sockets |
| </span><span class="kw">let </span>(sock1, sock2) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Since the sockets are paired, the paired send/recv |
| // functions can be used |
| </span><span class="kw">let </span>bytes = <span class="string">b"hail eris"</span>; |
| sock1.send(bytes).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buff = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>size = sock2.recv(<span class="kw-2">&mut </span>buff).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buff[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_std" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#464-468">source</a><h4 class="code-header">pub fn <a href="#method.from_std" class="fnname">from_std</a>(datagram: UnixDatagram) -> Result<<a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>></h4></section></summary><div class="docblock"><p>Creates new <code>UnixDatagram</code> from a <code>std::os::unix::net::UnixDatagram</code>.</p> |
| <p>This function is intended to be used to wrap a UnixDatagram from the |
| standard library in the Tokio equivalent. The conversion assumes |
| nothing about the underlying datagram; it is left up to the user to set |
| it in non-blocking mode.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This function panics if it is not called from within a runtime with |
| IO enabled.</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="../runtime/struct.Runtime.html#method.enter"><code>Runtime::enter</code></a> function.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::os::unix::net::UnixDatagram <span class="kw">as </span>StdUDS; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind the socket to a filesystem path |
| </span><span class="kw">let </span>socket_path = tmp.path().join(<span class="string">"socket"</span>); |
| <span class="kw">let </span>std_socket = StdUDS::bind(<span class="kw-2">&</span>socket_path)<span class="question-mark">?</span>; |
| std_socket.set_nonblocking(<span class="bool-val">true</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>tokio_socket = UnixDatagram::from_std(std_socket)<span class="question-mark">?</span>; |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_std" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#493-498">source</a><h4 class="code-header">pub fn <a href="#method.into_std" class="fnname">into_std</a>(self) -> Result<UnixDatagram></h4></section></summary><div class="docblock"><p>Turns a <a href="struct.UnixDatagram.html"><code>tokio::net::UnixDatagram</code></a> into a <a href="std::os::unix::net::UnixDatagram"><code>std::os::unix::net::UnixDatagram</code></a>.</p> |
| <p>The returned <a href="std::os::unix::net::UnixDatagram"><code>std::os::unix::net::UnixDatagram</code></a> will have nonblocking |
| mode set as <code>true</code>. Use <a href="fn@std::os::unix::net::UnixDatagram::set_nonblocking"><code>set_nonblocking</code></a> to change the blocking mode |
| if needed.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::error::Error; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>Error>> { |
| <span class="kw">let </span>tokio_socket = tokio::net::UnixDatagram::bind(<span class="string">"127.0.0.1:0"</span>)<span class="question-mark">?</span>; |
| <span class="kw">let </span>std_socket = tokio_socket.into_std()<span class="question-mark">?</span>; |
| std_socket.set_nonblocking(<span class="bool-val">false</span>)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.unbound" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#536-539">source</a><h4 class="code-header">pub fn <a href="#method.unbound" class="fnname">unbound</a>() -> Result<<a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>UnixDatagram</code> which is not bound to any address.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>tx = UnixDatagram::unbound()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Create another, bound socket |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Send to the bound socket |
| </span><span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| tx.send_to(bytes, <span class="kw-2">&</span>rx_path).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>(size, addr) = rx.recv_from(<span class="kw-2">&mut </span>buf).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buf[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.connect" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#578-580">source</a><h4 class="code-header">pub fn <a href="#method.connect" class="fnname">connect</a><P: AsRef<Path>>(&self, path: P) -> Result<()></h4></section></summary><div class="docblock"><p>Connects the socket to the specified address.</p> |
| <p>The <code>send</code> method may be used to send data to the specified address. |
| <code>recv</code> and <code>recv_from</code> will only receive data from that address.</p> |
| <h5 id="examples-9"><a href="#examples-9">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>tx = UnixDatagram::unbound()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Create another, bound socket |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Connect to the bound socket |
| </span>tx.connect(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Send to the bound socket |
| </span><span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| tx.send(bytes).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>(size, addr) = rx.recv_from(<span class="kw-2">&mut </span>buf).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buf[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#614-619">source</a><h4 class="code-header">pub async fn <a href="#method.send" class="fnname">send</a>(&self, buf: &[u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Sends data on the socket to the socket’s peer.</p> |
| <h5 id="cancel-safety-3"><a href="#cancel-safety-3">Cancel safety</a></h5> |
| <p>This method is cancel safe. If <code>send</code> is used as the event in a |
| <a href="../macro.select.html"><code>tokio::select!</code></a> statement and some other branch |
| completes first, then it is guaranteed that the message was not sent.</p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create the pair of sockets |
| </span><span class="kw">let </span>(sock1, sock2) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Since the sockets are paired, the paired send/recv |
| // functions can be used |
| </span><span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| sock1.send(bytes).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buff = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>size = sock2.recv(<span class="kw-2">&mut </span>buff).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buff[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_send" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#659-663">source</a><h4 class="code-header">pub fn <a href="#method.try_send" class="fnname">try_send</a>(&self, buf: &[u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Tries to send a datagram to the peer without waiting.</p> |
| <h5 id="examples-11"><a href="#examples-11">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be writable |
| </span>socket.writable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to send data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_send(<span class="string">b"hello world"</span>) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_send_to" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#702-709">source</a><h4 class="code-header">pub fn <a href="#method.try_send_to" class="fnname">try_send_to</a><P>(&self, buf: &[u8], target: P) -> Result<usize><span class="where fmt-newline">where<br> P: AsRef<Path>,</span></h4></section></summary><div class="docblock"><p>Tries to send a datagram to the peer without waiting.</p> |
| <h5 id="examples-12"><a href="#examples-12">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be writable |
| </span>socket.writable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to send data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_send_to(<span class="string">b"hello world"</span>, <span class="kw-2">&</span>server_path) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.recv" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#744-749">source</a><h4 class="code-header">pub async fn <a href="#method.recv" class="fnname">recv</a>(&self, buf: &mut [u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Receives data from the socket.</p> |
| <h5 id="cancel-safety-4"><a href="#cancel-safety-4">Cancel safety</a></h5> |
| <p>This method is cancel safe. If <code>recv</code> is used as the event in a |
| <a href="../macro.select.html"><code>tokio::select!</code></a> statement and some other branch |
| completes first, it is guaranteed that no messages were received on this |
| socket.</p> |
| <h5 id="examples-13"><a href="#examples-13">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create the pair of sockets |
| </span><span class="kw">let </span>(sock1, sock2) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Since the sockets are paired, the paired send/recv |
| // functions can be used |
| </span><span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| sock1.send(bytes).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buff = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>size = sock2.recv(<span class="kw-2">&mut </span>buff).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buff[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_recv" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#795-799">source</a><h4 class="code-header">pub fn <a href="#method.try_recv" class="fnname">try_recv</a>(&self, buf: &mut [u8]) -> Result<usize></h4></section></summary><div class="docblock"><p>Tries to receive a datagram from the peer without waiting.</p> |
| <h5 id="examples-14"><a href="#examples-14">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="comment">// Connect to a peer |
| </span><span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be readable |
| </span>socket.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// The buffer is **not** included in the async task and will |
| // only exist on the stack. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">1024</span>]; |
| |
| <span class="comment">// Try to recv data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_recv(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span>buf[..n]); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_recv_buf_from" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#843-861">source</a><h4 class="code-header">pub fn <a href="#method.try_recv_buf_from" class="fnname">try_recv_buf_from</a><B: <a class="trait" href="../../bytes/buf/buf_mut/trait.BufMut.html" title="trait bytes::buf::buf_mut::BufMut">BufMut</a>>(<br> &self,<br> buf: &mut B<br>) -> Result<(usize, <a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>)></h4></section></summary><div class="docblock"><p>Tries to receive data from the socket without waiting.</p> |
| <h5 id="examples-15"><a href="#examples-15">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="comment">// Connect to a peer |
| </span><span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be readable |
| </span>socket.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = Vec::with_capacity(<span class="number">1024</span>); |
| |
| <span class="comment">// Try to recv data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_recv_buf_from(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>((n, _addr)) => { |
| <span class="macro">println!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span>buf[..n]); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_recv_buf" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#906-922">source</a><h4 class="code-header">pub fn <a href="#method.try_recv_buf" class="fnname">try_recv_buf</a><B: <a class="trait" href="../../bytes/buf/buf_mut/trait.BufMut.html" title="trait bytes::buf::buf_mut::BufMut">BufMut</a>>(&self, buf: &mut B) -> Result<usize></h4></section></summary><div class="docblock"><p>Tries to read data from the stream into the provided buffer, advancing the |
| buffer’s internal cursor, returning how many bytes were read.</p> |
| <h5 id="examples-16"><a href="#examples-16">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="comment">// Connect to a peer |
| </span><span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| socket.connect(<span class="kw-2">&</span>server_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be readable |
| </span>socket.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = Vec::with_capacity(<span class="number">1024</span>); |
| |
| <span class="comment">// Try to recv data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_recv_buf(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span>buf[..n]); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_to" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#964-972">source</a><h4 class="code-header">pub async fn <a href="#method.send_to" class="fnname">send_to</a><P>(&self, buf: &[u8], target: P) -> Result<usize><span class="where fmt-newline">where<br> P: AsRef<Path>,</span></h4></section></summary><div class="docblock"><p>Sends data on the socket to the specified address.</p> |
| <h5 id="cancel-safety-5"><a href="#cancel-safety-5">Cancel safety</a></h5> |
| <p>This method is cancel safe. If <code>send_to</code> is used as the event in a |
| <a href="../macro.select.html"><code>tokio::select!</code></a> statement and some other branch |
| completes first, then it is guaranteed that the message was not sent.</p> |
| <h5 id="examples-17"><a href="#examples-17">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind each socket to a filesystem path |
| </span><span class="kw">let </span>tx_path = tmp.path().join(<span class="string">"tx"</span>); |
| <span class="kw">let </span>tx = UnixDatagram::bind(<span class="kw-2">&</span>tx_path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| tx.send_to(bytes, <span class="kw-2">&</span>rx_path).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>(size, addr) = rx.recv_from(<span class="kw-2">&mut </span>buf).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buf[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| <span class="macro">assert_eq!</span>(addr.as_pathname().unwrap(), <span class="kw-2">&</span>tx_path); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.recv_from" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1014-1022">source</a><h4 class="code-header">pub async fn <a href="#method.recv_from" class="fnname">recv_from</a>(&self, buf: &mut [u8]) -> Result<(usize, <a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>)></h4></section></summary><div class="docblock"><p>Receives data from the socket.</p> |
| <h5 id="cancel-safety-6"><a href="#cancel-safety-6">Cancel safety</a></h5> |
| <p>This method is cancel safe. If <code>recv_from</code> is used as the event in a |
| <a href="../macro.select.html"><code>tokio::select!</code></a> statement and some other branch |
| completes first, it is guaranteed that no messages were received on this |
| socket.</p> |
| <h5 id="examples-18"><a href="#examples-18">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind each socket to a filesystem path |
| </span><span class="kw">let </span>tx_path = tmp.path().join(<span class="string">"tx"</span>); |
| <span class="kw">let </span>tx = UnixDatagram::bind(<span class="kw-2">&</span>tx_path)<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>bytes = <span class="string">b"hello world"</span>; |
| tx.send_to(bytes, <span class="kw-2">&</span>rx_path).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">24</span>]; |
| <span class="kw">let </span>(size, addr) = rx.recv_from(<span class="kw-2">&mut </span>buf).<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>dgram = <span class="kw-2">&</span>buf[..size]; |
| <span class="macro">assert_eq!</span>(dgram, bytes); |
| <span class="macro">assert_eq!</span>(addr.as_pathname().unwrap(), <span class="kw-2">&</span>tx_path); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_recv_from" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1041-1061">source</a><h4 class="code-header">pub fn <a href="#method.poll_recv_from" class="fnname">poll_recv_from</a>(<br> &self,<br> cx: &mut Context<'_>,<br> buf: &mut <a class="struct" href="../io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> Poll<Result<<a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>>></h4></section></summary><div class="docblock"><p>Attempts to receive a single datagram on the specified address.</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> |
| <h5 id="return-value-2"><a href="#return-value-2">Return value</a></h5> |
| <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> |
| <h5 id="errors-2"><a href="#errors-2">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_send_to" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1080-1092">source</a><h4 class="code-header">pub fn <a href="#method.poll_send_to" class="fnname">poll_send_to</a><P>(<br> &self,<br> cx: &mut Context<'_>,<br> buf: &[u8],<br> target: P<br>) -> Poll<Result<usize>><span class="where fmt-newline">where<br> P: AsRef<Path>,</span></h4></section></summary><div class="docblock"><p>Attempts to send data to the specified 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> |
| <h5 id="return-value-3"><a href="#return-value-3">Return value</a></h5> |
| <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> |
| <h5 id="errors-3"><a href="#errors-3">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_send" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1117-1121">source</a><h4 class="code-header">pub fn <a href="#method.poll_send" class="fnname">poll_send</a>(&self, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>></h4></section></summary><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="struct.UnixDatagram.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> |
| <h5 id="return-value-4"><a href="#return-value-4">Return value</a></h5> |
| <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> |
| <h5 id="errors-4"><a href="#errors-4">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_recv" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1146-1162">source</a><h4 class="code-header">pub fn <a href="#method.poll_recv" class="fnname">poll_recv</a>(<br> &self,<br> cx: &mut Context<'_>,<br> buf: &mut <a class="struct" href="../io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> Poll<Result<()>></h4></section></summary><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="struct.UnixDatagram.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> |
| <h5 id="return-value-5"><a href="#return-value-5">Return value</a></h5> |
| <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> |
| <h5 id="errors-5"><a href="#errors-5">Errors</a></h5> |
| <p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_recv_from" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1207-1214">source</a><h4 class="code-header">pub fn <a href="#method.try_recv_from" class="fnname">try_recv_from</a>(&self, buf: &mut [u8]) -> Result<(usize, <a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>)></h4></section></summary><div class="docblock"><p>Tries to receive data from the socket without waiting.</p> |
| <h5 id="examples-19"><a href="#examples-19">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="comment">// Connect to a peer |
| </span><span class="kw">let </span>dir = tempfile::tempdir().unwrap(); |
| <span class="kw">let </span>client_path = dir.path().join(<span class="string">"client.sock"</span>); |
| <span class="kw">let </span>server_path = dir.path().join(<span class="string">"server.sock"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>client_path)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the socket to be readable |
| </span>socket.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// The buffer is **not** included in the async task and will |
| // only exist on the stack. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">1024</span>]; |
| |
| <span class="comment">// Try to recv data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>socket.try_recv_from(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>((n, _addr)) => { |
| <span class="macro">println!</span>(<span class="string">"GOT {:?}"</span>, <span class="kw-2">&</span>buf[..n]); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(e); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_io" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1248-1256">source</a><h4 class="code-header">pub fn <a href="#method.try_io" class="fnname">try_io</a><R>(<br> &self,<br> interest: <a class="struct" href="../io/struct.Interest.html" title="struct tokio::io::Interest">Interest</a>,<br> f: impl FnOnce() -> Result<R><br>) -> Result<R></h4></section></summary><div class="docblock"><p>Tries to read or write from the socket using a user-provided IO operation.</p> |
| <p>If the socket is ready, the provided closure is called. The closure |
| should attempt to perform IO operation on the socket by manually |
| calling the appropriate syscall. If the operation fails because the |
| socket is not actually ready, then the closure should return a |
| <code>WouldBlock</code> error and the readiness flag is cleared. The return value |
| of the closure is then returned by <code>try_io</code>.</p> |
| <p>If the socket is not ready, then the closure is not called |
| and a <code>WouldBlock</code> error is returned.</p> |
| <p>The closure should only return a <code>WouldBlock</code> error if it has performed |
| an IO operation on the socket that failed due to the socket not being |
| ready. Returning a <code>WouldBlock</code> error in any other situation will |
| incorrectly clear the readiness flag, which can cause the socket to |
| behave incorrectly.</p> |
| <p>The closure should not perform the IO operation using any of the methods |
| defined on the Tokio <code>UnixDatagram</code> type, as this will mess with the |
| readiness flag and can cause the socket to behave incorrectly.</p> |
| <p>This method is not intended to be used with combined interests. |
| The closure should perform only one type of IO operation, so it should not |
| require more than one ready state. This method may panic or sleep forever |
| if it is called with a combined interest.</p> |
| <p>Usually, <a href="struct.UnixDatagram.html#method.readable"><code>readable()</code></a>, <a href="struct.UnixDatagram.html#method.writable"><code>writable()</code></a> or <a href="struct.UnixDatagram.html#method.ready"><code>ready()</code></a> is used with this function.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.local_addr" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1298-1300">source</a><h4 class="code-header">pub fn <a href="#method.local_addr" class="fnname">local_addr</a>(&self) -> Result<<a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>></h4></section></summary><div class="docblock"><p>Returns the local address that this socket is bound to.</p> |
| <h5 id="examples-20"><a href="#examples-20">Examples</a></h5> |
| <p>For a socket bound to a local path</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// We use a temporary directory so that the socket |
| // files left by the bound sockets will get cleaned up. |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Bind socket to a filesystem path |
| </span><span class="kw">let </span>socket_path = tmp.path().join(<span class="string">"socket"</span>); |
| <span class="kw">let </span>socket = UnixDatagram::bind(<span class="kw-2">&</span>socket_path)<span class="question-mark">?</span>; |
| |
| <span class="macro">assert_eq!</span>(socket.local_addr()<span class="question-mark">?</span>.as_pathname().unwrap(), <span class="kw-2">&</span>socket_path); |
| </code></pre></div> |
| <p>For an unbound socket</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>socket = UnixDatagram::unbound()<span class="question-mark">?</span>; |
| |
| <span class="macro">assert!</span>(socket.local_addr()<span class="question-mark">?</span>.is_unnamed()); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.peer_addr" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1347-1349">source</a><h4 class="code-header">pub fn <a href="#method.peer_addr" class="fnname">peer_addr</a>(&self) -> Result<<a class="struct" href="unix/struct.SocketAddr.html" title="struct tokio::net::unix::SocketAddr">SocketAddr</a>></h4></section></summary><div class="docblock"><p>Returns the address of this socket’s peer.</p> |
| <p>The <code>connect</code> method will connect the socket to a peer.</p> |
| <h5 id="examples-21"><a href="#examples-21">Examples</a></h5> |
| <p>For a peer with a local path</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>tempfile::tempdir; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>tx = UnixDatagram::unbound()<span class="question-mark">?</span>; |
| |
| <span class="comment">// Create another, bound socket |
| </span><span class="kw">let </span>tmp = tempdir()<span class="question-mark">?</span>; |
| <span class="kw">let </span>rx_path = tmp.path().join(<span class="string">"rx"</span>); |
| <span class="kw">let </span>rx = UnixDatagram::bind(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="comment">// Connect to the bound socket |
| </span>tx.connect(<span class="kw-2">&</span>rx_path)<span class="question-mark">?</span>; |
| |
| <span class="macro">assert_eq!</span>(tx.peer_addr()<span class="question-mark">?</span>.as_pathname().unwrap(), <span class="kw-2">&</span>rx_path); |
| </code></pre></div> |
| <p>For an unbound peer</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create the pair of sockets |
| </span><span class="kw">let </span>(sock1, sock2) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| <span class="macro">assert!</span>(sock1.peer_addr()<span class="question-mark">?</span>.is_unnamed()); |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take_error" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1370-1372">source</a><h4 class="code-header">pub fn <a href="#method.take_error" class="fnname">take_error</a>(&self) -> Result<Option<Error>></h4></section></summary><div class="docblock"><p>Returns the value of the <code>SO_ERROR</code> option.</p> |
| <h5 id="examples-22"><a href="#examples-22">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>socket = UnixDatagram::unbound()<span class="question-mark">?</span>; |
| |
| <span class="kw">if let </span><span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(err)) = socket.take_error() { |
| <span class="macro">println!</span>(<span class="string">"Got error: {:?}"</span>, err); |
| } |
| </code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.shutdown" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1406-1408">source</a><h4 class="code-header">pub fn <a href="#method.shutdown" class="fnname">shutdown</a>(&self, how: Shutdown) -> Result<()></h4></section></summary><div class="docblock"><p>Shuts down the read, write, or both halves of this connection.</p> |
| <p>This function will cause all pending and future I/O calls on the |
| specified portions to immediately return with an appropriate value |
| (see the documentation of <code>Shutdown</code>).</p> |
| <h5 id="examples-23"><a href="#examples-23">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::UnixDatagram; |
| <span class="kw">use </span>std::net::Shutdown; |
| |
| <span class="comment">// Create an unbound socket |
| </span><span class="kw">let </span>(socket, other) = UnixDatagram::pair()<span class="question-mark">?</span>; |
| |
| socket.shutdown(Shutdown::Both)<span class="question-mark">?</span>; |
| |
| <span class="comment">// NOTE: the following commented out code does NOT work as expected. |
| // Due to an underlying issue, the recv call will block indefinitely. |
| // See: https://github.com/tokio-rs/tokio/issues/1679 |
| //let mut buff = vec![0u8; 24]; |
| //let size = socket.recv(&mut buff).await?; |
| //assert_eq!(size, 0); |
| |
| </span><span class="kw">let </span>send_result = socket.send(<span class="string">b"hello world"</span>).<span class="kw">await</span>; |
| <span class="macro">assert!</span>(send_result.is_err()); |
| </code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsRawFd-for-UnixDatagram" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1429-1433">source</a><a href="#impl-AsRawFd-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl AsRawFd for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_raw_fd" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1430-1432">source</a><a href="#method.as_raw_fd" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_raw_fd</a>(&self) -> RawFd</h4></section></summary><div class='docblock'>Extracts the raw file descriptor. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-UnixDatagram" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1423-1427">source</a><a href="#impl-Debug-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1424-1426">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-TryFrom%3CUnixDatagram%3E-for-UnixDatagram" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1411-1421">source</a><a href="#impl-TryFrom%3CUnixDatagram%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl TryFrom<UnixDatagram> for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/net/unix/datagram/socket.rs.html#1418-1420">source</a><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(stream: UnixDatagram) -> Result<Self, Self::Error></h4></section></summary><div class="docblock"><p>Consumes stream, returning the Tokio I/O object.</p> |
| <p>This is equivalent to |
| <a href="struct.UnixDatagram.html#method.from_std"><code>UnixDatagram::from_std(stream)</code></a>.</p> |
| </div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details></div></details></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"><section id="impl-RefUnwindSafe-for-UnixDatagram" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-Send-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Send-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-Sync-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Sync-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-Unpin-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Unpin-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section><section id="impl-UnwindSafe-for-UnixDatagram" class="impl has-srclink"><a href="#impl-UnwindSafe-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.UnixDatagram.html" title="struct tokio::net::UnixDatagram">UnixDatagram</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Any-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from-1" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from-1" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-UnixDatagram" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-UnixDatagram" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
