| <!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="Reading end of a Unix pipe."><meta name="keywords" content="rust, rustlang, rust-lang, Receiver"><title>Receiver in tokio::net::unix::pipe - 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="#">Receiver</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.from_file">from_file</a></li><li><a href="#method.from_file_unchecked">from_file_unchecked</a></li><li><a href="#method.poll_read_ready">poll_read_ready</a></li><li><a href="#method.readable">readable</a></li><li><a href="#method.ready">ready</a></li><li><a href="#method.try_read">try_read</a></li><li><a href="#method.try_read_buf">try_read_buf</a></li><li><a href="#method.try_read_vectored">try_read_vectored</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsFd-for-Receiver">AsFd</a></li><li><a href="#impl-AsRawFd-for-Receiver">AsRawFd</a></li><li><a href="#impl-AsyncRead-for-Receiver">AsyncRead</a></li><li><a href="#impl-Debug-for-Receiver">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Receiver">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Receiver">Send</a></li><li><a href="#impl-Sync-for-Receiver">Sync</a></li><li><a href="#impl-Unpin-for-Receiver">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Receiver">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Receiver">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Receiver">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Receiver">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Receiver">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Receiver">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Receiver">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Receiver">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::net::unix::pipe</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 href="../index.html">unix</a>::<wbr><a href="index.html">pipe</a>::<wbr><a class="struct" href="#">Receiver</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/pipe.rs.html#742-744">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 Receiver { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Reading end of a Unix pipe.</p> |
| <p>It can be constructed from a FIFO file with <a href="struct.OpenOptions.html#method.open_receiver" title="OpenOptions::open_receiver"><code>OpenOptions::open_receiver</code></a>.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Receiving messages from a named pipe in a loop:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::unix::pipe; |
| <span class="kw">use </span>tokio::io::{<span class="self">self</span>, AsyncReadExt}; |
| |
| <span class="kw">const </span>FIFO_NAME: <span class="kw-2">&</span>str = <span class="string">"path/to/a/fifo"</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>rx = pipe::OpenOptions::new().open_receiver(FIFO_NAME)<span class="question-mark">?</span>; |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">256</span>]; |
| <span class="kw">match </span>rx.read_exact(<span class="kw-2">&mut </span>msg).<span class="kw">await </span>{ |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => { |
| <span class="comment">/* handle the message */ |
| </span>} |
| <span class="prelude-val">Err</span>(e) <span class="kw">if </span>e.kind() == io::ErrorKind::UnexpectedEof => { |
| <span class="comment">// Writing end has been closed, we should reopen the pipe. |
| </span>rx = pipe::OpenOptions::new().open_receiver(FIFO_NAME)<span class="question-mark">?</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => <span class="kw">return </span><span class="prelude-val">Err</span>(e.into()), |
| } |
| }</code></pre></div> |
| <p>On Linux, you can use a <code>Receiver</code> in read-write access mode to implement |
| resilient reading from a named pipe. Unlike <code>Receiver</code> opened in read-only |
| mode, read from a pipe in read-write mode will not fail with <code>UnexpectedEof</code> |
| when the writing end is closed. This way, a <code>Receiver</code> can asynchronously |
| wait for the next writer to open the pipe.</p> |
| <p>You should not use functions waiting for EOF such as <a href="../../../io/trait.AsyncReadExt.html#method.read_to_end"><code>read_to_end</code></a> with |
| a <code>Receiver</code> in read-write access mode, since it <strong>may wait forever</strong>. |
| <code>Receiver</code> in this mode also holds an open writing end, which prevents |
| receiving EOF.</p> |
| <p>To set the read-write access mode you can use <code>OpenOptions::read_write</code>. |
| Note that using read-write access mode with FIFO files is not defined by |
| the POSIX standard and it is only guaranteed to work on Linux.</p> |
| |
| <div class="example-wrap ignore"><div class='tooltip'>ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::unix::pipe; |
| <span class="kw">use </span>tokio::io::AsyncReadExt; |
| |
| <span class="kw">const </span>FIFO_NAME: <span class="kw-2">&</span>str = <span class="string">"path/to/a/fifo"</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>rx = pipe::OpenOptions::new() |
| .read_write(<span class="bool-val">true</span>) |
| .open_receiver(FIFO_NAME)<span class="question-mark">?</span>; |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">256</span>]; |
| rx.read_exact(<span class="kw-2">&mut </span>msg).<span class="kw">await</span><span class="question-mark">?</span>; |
| <span class="comment">/* handle the message */ |
| </span>}</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-Receiver" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#746-1153">source</a><a href="#impl-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_file" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#771-786">source</a><h4 class="code-header">pub fn <a href="#method.from_file" class="fnname">from_file</a>(file: <a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Receiver</code> from a <a href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="File"><code>File</code></a>.</p> |
| <p>This function is intended to construct a pipe from a <a href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="File"><code>File</code></a> representing |
| a special FIFO file. It will check if the file is a pipe and has read access, |
| set it in non-blocking mode and perform the conversion.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>Fails with <code>io::ErrorKind::InvalidInput</code> if the file is not a pipe or it |
| does not have read access. Also fails with any standard OS error if it occurs.</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> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_file_unchecked" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#826-830">source</a><h4 class="code-header">pub fn <a href="#method.from_file_unchecked" class="fnname">from_file_unchecked</a>(file: <a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Receiver</code> from a <a href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="File"><code>File</code></a> without checking pipe properties.</p> |
| <p>This function is intended to construct a pipe from a File representing |
| a special FIFO file. The conversion assumes nothing about the underlying |
| file; it is left up to the user to make sure it is opened with read access, |
| represents a pipe and is set in non-blocking mode.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::net::unix::pipe; |
| <span class="kw">use </span>std::fs::OpenOptions; |
| <span class="kw">use </span>std::os::unix::fs::{FileTypeExt, OpenOptionsExt}; |
| |
| <span class="kw">const </span>FIFO_NAME: <span class="kw-2">&</span>str = <span class="string">"path/to/a/fifo"</span>; |
| |
| <span class="kw">let </span>file = OpenOptions::new() |
| .read(<span class="bool-val">true</span>) |
| .custom_flags(libc::O_NONBLOCK) |
| .open(FIFO_NAME)<span class="question-mark">?</span>; |
| <span class="kw">if </span>file.metadata()<span class="question-mark">?</span>.file_type().is_fifo() { |
| <span class="kw">let </span>rx = pipe::Receiver::from_file_unchecked(file)<span class="question-mark">?</span>; |
| <span class="comment">/* use the Receiver */ |
| </span>}</code></pre></div> |
| <h5 id="panics-1"><a href="#panics-1">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> |
| </div></details><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/pipe.rs.html#851-854">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>) -> <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="../../../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 can be used instead of <a href="struct.Receiver.html#method.readable"><code>readable()</code></a> to check the returned |
| ready set for <a href="../../../io/struct.Ready.html#associatedconstant.READABLE" title="Ready::READABLE"><code>Ready::READABLE</code></a> and <a href="../../../io/struct.Ready.html#associatedconstant.READ_CLOSED" title="Ready::READ_CLOSED"><code>Ready::READ_CLOSED</code></a> events.</p> |
| <p>The function may complete without the pipe 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 that fails with <code>WouldBlock</code> or |
| <code>Poll::Pending</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/pipe.rs.html#900-903">source</a><h4 class="code-header">pub async fn <a href="#method.readable" class="fnname">readable</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Waits for the pipe to become readable.</p> |
| <p>This function is equivalent to <code>ready(Interest::READABLE)</code> and is usually |
| paired with <a href="struct.Receiver.html#method.try_read"><code>try_read()</code></a>.</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::unix::pipe; |
| <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">// Open a reading end of a fifo |
| </span><span class="kw">let </span>rx = pipe::OpenOptions::new().open_receiver(<span class="string">"path/to/a/fifo"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">1024</span>]; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the pipe to be readable |
| </span>rx.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to read data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>rx.try_read(<span class="kw-2">&mut </span>msg) { |
| <span class="prelude-val">Ok</span>(n) => { |
| msg.truncate(n); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</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.into()); |
| } |
| } |
| } |
| |
| <span class="macro">println!</span>(<span class="string">"GOT = {:?}"</span>, msg); |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read_ready" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#932-934">source</a><h4 class="code-header">pub fn <a href="#method.poll_read_ready" class="fnname">poll_read_ready</a>(&self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></h4></section></summary><div class="docblock"><p>Polls for read readiness.</p> |
| <p>If the pipe is not currently ready for reading, this method will |
| store a clone of the <code>Waker</code> from the provided <code>Context</code>. When the pipe |
| becomes ready for reading, <code>Waker::wake</code> will be called on the waker.</p> |
| <p>Note that on multiple calls to <code>poll_read_ready</code> or <code>poll_read</code>, only |
| the <code>Waker</code> from the <code>Context</code> passed to the most recent call is |
| scheduled to receive a wakeup.</p> |
| <p>This function is intended for cases where creating and pinning a future |
| via <a href="struct.Receiver.html#method.readable"><code>readable</code></a> is not feasible. Where possible, using <a href="struct.Receiver.html#method.readable"><code>readable</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 pipe is not ready for reading.</li> |
| <li><code>Poll::Ready(Ok(()))</code> if the pipe 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.try_read" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#996-1000">source</a><h4 class="code-header">pub fn <a href="#method.try_read" class="fnname">try_read</a>(&self, buf: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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>></h4></section></summary><div class="docblock"><p>Tries to read data from the pipe into the provided buffer, returning how |
| many bytes were read.</p> |
| <p>Reads any pending data from the pipe but does not wait for new data |
| to arrive. On success, returns the number of bytes read. Because |
| <code>try_read()</code> is non-blocking, the buffer does not have to be stored by |
| the async task and can exist entirely on the stack.</p> |
| <p>Usually <a href="struct.Receiver.html#method.readable"><code>readable()</code></a> is used with this function.</p> |
| <h5 id="return"><a href="#return">Return</a></h5> |
| <p>If data is successfully read, <code>Ok(n)</code> is returned, where <code>n</code> is the |
| number of bytes read. If <code>n</code> is <code>0</code>, then it can indicate one of two scenarios:</p> |
| <ol> |
| <li>The pipe’s writing end is closed and will no longer write data.</li> |
| <li>The specified buffer was 0 bytes in length.</li> |
| </ol> |
| <p>If the pipe is not ready to read data, |
| <code>Err(io::ErrorKind::WouldBlock)</code> is returned.</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::unix::pipe; |
| <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">// Open a reading end of a fifo |
| </span><span class="kw">let </span>rx = pipe::OpenOptions::new().open_receiver(<span class="string">"path/to/a/fifo"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">1024</span>]; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the pipe to be readable |
| </span>rx.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Try to read data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>rx.try_read(<span class="kw-2">&mut </span>msg) { |
| <span class="prelude-val">Ok</span>(n) => { |
| msg.truncate(n); |
| <span class="kw">break</span>; |
| } |
| <span class="prelude-val">Err</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.into()); |
| } |
| } |
| } |
| |
| <span class="macro">println!</span>(<span class="string">"GOT = {:?}"</span>, msg); |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_vectored" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1070-1074">source</a><h4 class="code-header">pub fn <a href="#method.try_read_vectored" class="fnname">try_read_vectored</a>(&self, bufs: &mut [<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/struct.IoSliceMut.html" title="struct std::io::IoSliceMut">IoSliceMut</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>></h4></section></summary><div class="docblock"><p>Tries to read data from the pipe into the provided buffers, returning |
| how many bytes were read.</p> |
| <p>Data is copied to fill each buffer in order, with the final buffer |
| written to possibly being only partially filled. This method behaves |
| equivalently to a single call to <a href="struct.Receiver.html#method.try_read"><code>try_read()</code></a> with concatenated |
| buffers.</p> |
| <p>Reads any pending data from the pipe but does not wait for new data |
| to arrive. On success, returns the number of bytes read. Because |
| <code>try_read_vectored()</code> is non-blocking, the buffer does not have to be |
| stored by the async task and can exist entirely on the stack.</p> |
| <p>Usually, <a href="struct.Receiver.html#method.readable"><code>readable()</code></a> is used with this function.</p> |
| <h5 id="return-1"><a href="#return-1">Return</a></h5> |
| <p>If data is successfully read, <code>Ok(n)</code> is returned, where <code>n</code> is the |
| number of bytes read. <code>Ok(0)</code> indicates the pipe’s writing end is |
| closed and will no longer write data. If the pipe is not ready to read |
| data <code>Err(io::ErrorKind::WouldBlock)</code> is returned.</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::unix::pipe; |
| <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">// Open a reading end of a fifo |
| </span><span class="kw">let </span>rx = pipe::OpenOptions::new().open_receiver(<span class="string">"path/to/a/fifo"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the pipe to be readable |
| </span>rx.readable().<span class="kw">await</span><span class="question-mark">?</span>; |
| |
| <span class="comment">// Creating the buffer **after** the `await` prevents it from |
| // being stored in the async task. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>buf_a = [<span class="number">0</span>; <span class="number">512</span>]; |
| <span class="kw">let </span><span class="kw-2">mut </span>buf_b = [<span class="number">0</span>; <span class="number">1024</span>]; |
| <span class="kw">let </span><span class="kw-2">mut </span>bufs = [ |
| io::IoSliceMut::new(<span class="kw-2">&mut </span>buf_a), |
| io::IoSliceMut::new(<span class="kw-2">&mut </span>buf_b), |
| ]; |
| |
| <span class="comment">// Try to read data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>rx.try_read_vectored(<span class="kw-2">&mut </span>bufs) { |
| <span class="prelude-val">Ok</span>(<span class="number">0</span>) => <span class="kw">break</span>, |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"read {} bytes"</span>, n); |
| } |
| <span class="prelude-val">Err</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.into()); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_read_buf" class="method has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1133-1151">source</a><h4 class="code-header">pub fn <a href="#method.try_read_buf" class="fnname">try_read_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: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>B) -> <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>></h4></section></summary><div class="docblock"><p>Tries to read data from the pipe into the provided buffer, advancing the |
| buffer’s internal cursor, returning how many bytes were read.</p> |
| <p>Reads any pending data from the pipe but does not wait for new data |
| to arrive. On success, returns the number of bytes read. Because |
| <code>try_read_buf()</code> is non-blocking, the buffer does not have to be stored by |
| the async task and can exist entirely on the stack.</p> |
| <p>Usually, <a href="struct.Receiver.html#method.readable"><code>readable()</code></a> or <a href="struct.Receiver.html#method.ready"><code>ready()</code></a> is used with this function.</p> |
| <h5 id="return-2"><a href="#return-2">Return</a></h5> |
| <p>If data is successfully read, <code>Ok(n)</code> is returned, where <code>n</code> is the |
| number of bytes read. <code>Ok(0)</code> indicates the pipe’s writing end is |
| closed and will no longer write data. If the pipe is not ready to read |
| data <code>Err(io::ErrorKind::WouldBlock)</code> is returned.</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::unix::pipe; |
| <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">// Open a reading end of a fifo |
| </span><span class="kw">let </span>rx = pipe::OpenOptions::new().open_receiver(<span class="string">"path/to/a/fifo"</span>)<span class="question-mark">?</span>; |
| |
| <span class="kw">loop </span>{ |
| <span class="comment">// Wait for the pipe to be readable |
| </span>rx.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">4096</span>); |
| |
| <span class="comment">// Try to read data, this may still fail with `WouldBlock` |
| // if the readiness event is a false positive. |
| </span><span class="kw">match </span>rx.try_read_buf(<span class="kw-2">&mut </span>buf) { |
| <span class="prelude-val">Ok</span>(<span class="number">0</span>) => <span class="kw">break</span>, |
| <span class="prelude-val">Ok</span>(n) => { |
| <span class="macro">println!</span>(<span class="string">"read {} bytes"</span>, n); |
| } |
| <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.into()); |
| } |
| } |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }</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-AsFd-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1174-1178">source</a><a href="#impl-AsFd-for-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/os/fd/owned/trait.AsFd.html" title="trait std::os::fd::owned::AsFd">AsFd</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_fd" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1175-1177">source</a><a href="#method.as_fd" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd" class="fnname">as_fd</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/os/fd/owned/struct.BorrowedFd.html" title="struct std::os::fd::owned::BorrowedFd">BorrowedFd</a><'_></h4></section></summary><div class='docblock'>Borrows the file descriptor. <a href="https://doc.rust-lang.org/nightly/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsRawFd-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1167-1171">source</a><a href="#impl-AsRawFd-for-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/os/fd/raw/trait.AsRawFd.html" title="trait std::os::fd::raw::AsRawFd">AsRawFd</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</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/pipe.rs.html#1168-1170">source</a><a href="#method.as_raw_fd" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/std/os/fd/raw/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/os/fd/raw/type.RawFd.html" title="type std::os::fd::raw::RawFd">RawFd</a></h4></section></summary><div class='docblock'>Extracts the raw file descriptor. <a href="https://doc.rust-lang.org/nightly/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncRead-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1155-1165">source</a><a href="#impl-AsyncRead-for-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../../io/trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1156-1164">source</a><a href="#method.poll_read" class="anchor"></a><h4 class="code-header">fn <a href="../../../io/trait.AsyncRead.html#tymethod.poll_read" class="fnname">poll_read</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>,<br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,<br> buf: &mut <a class="struct" href="../../../io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></h4></section></summary><div class='docblock'>Attempts to read from the <code>AsyncRead</code> into <code>buf</code>. <a href="../../../io/trait.AsyncRead.html#tymethod.poll_read">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#741">source</a><a href="#impl-Debug-for-Receiver" class="anchor"></a><h3 class="code-header">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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</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/pipe.rs.html#741">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">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></h4></section></summary><div class='docblock'>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></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-Receiver" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section><section id="impl-Send-for-Receiver" class="impl has-srclink"><a href="#impl-Send-for-Receiver" class="anchor"></a><h3 class="code-header">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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section><section id="impl-Sync-for-Receiver" class="impl has-srclink"><a href="#impl-Sync-for-Receiver" class="anchor"></a><h3 class="code-header">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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section><section id="impl-Unpin-for-Receiver" class="impl has-srclink"><a href="#impl-Unpin-for-Receiver" class="anchor"></a><h3 class="code-header">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="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section><section id="impl-UnwindSafe-for-Receiver" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Receiver" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</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-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Receiver" class="anchor"></a><h3 class="code-header">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></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 class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">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></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">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</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">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</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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</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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" 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-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" 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><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><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-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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></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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></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" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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-Receiver" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Receiver" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></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> |
