410 lines
85 KiB
HTML
410 lines
85 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Reading end of a Unix pipe."><title>Receiver in tokio::net::unix::pipe - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Receiver</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Receiver</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.from_file" title="from_file">from_file</a></li><li><a href="#method.from_file_unchecked" title="from_file_unchecked">from_file_unchecked</a></li><li><a href="#method.from_owned_fd" title="from_owned_fd">from_owned_fd</a></li><li><a href="#method.from_owned_fd_unchecked" title="from_owned_fd_unchecked">from_owned_fd_unchecked</a></li><li><a href="#method.into_blocking_fd" title="into_blocking_fd">into_blocking_fd</a></li><li><a href="#method.into_nonblocking_fd" title="into_nonblocking_fd">into_nonblocking_fd</a></li><li><a href="#method.poll_read_ready" title="poll_read_ready">poll_read_ready</a></li><li><a href="#method.readable" title="readable">readable</a></li><li><a href="#method.ready" title="ready">ready</a></li><li><a href="#method.try_read" title="try_read">try_read</a></li><li><a href="#method.try_read_buf" title="try_read_buf">try_read_buf</a></li><li><a href="#method.try_read_vectored" title="try_read_vectored">try_read_vectored</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-AsFd-for-Receiver" title="AsFd">AsFd</a></li><li><a href="#impl-AsRawFd-for-Receiver" title="AsRawFd">AsRawFd</a></li><li><a href="#impl-AsyncRead-for-Receiver" title="AsyncRead">AsyncRead</a></li><li><a href="#impl-Debug-for-Receiver" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Receiver" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Receiver" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Receiver" title="Send">Send</a></li><li><a href="#impl-Sync-for-Receiver" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Receiver" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Receiver" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-AsyncReadExt-for-R" title="AsyncReadExt">AsyncReadExt</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>net::<wbr>unix::<wbr>pipe</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><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></div><h1>Struct <span class="struct">Receiver</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/tokio/net/unix/pipe.rs.html#861-863">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Receiver { <span class="comment">/* private fields */</span> }</code></pre><details class="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="method tokio::net::unix::pipe::OpenOptions::open_receiver"><code>OpenOptions::open_receiver</code></a>.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</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" title="method tokio::io::AsyncReadExt::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"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><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="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Receiver" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#865-1342">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="toggle method-toggle" open><summary><section id="method.from_file" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#890-892">Source</a><h4 class="code-header">pub fn <a href="#method.from_file" class="fn">from_file</a>(file: <a class="struct" href="https://doc.rust-lang.org/1.93.1/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/std/fs/struct.File.html" title="struct std::fs::File"><code>File</code></a>.</p>
|
||
<p>This function is intended to construct a pipe from a <a href="https://doc.rust-lang.org/1.93.1/std/fs/struct.File.html" title="struct std::fs::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 class="doc-anchor" href="#errors">§</a>Errors</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 class="doc-anchor" href="#panics">§</a>Panics</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" title="method tokio::runtime::Runtime::enter"><code>Runtime::enter</code></a> function.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_owned_fd" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#915-930">Source</a><h4 class="code-header">pub fn <a href="#method.from_owned_fd" class="fn">from_owned_fd</a>(owned_fd: <a class="struct" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd">OwnedFd</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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 an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a>.</p>
|
||
<p>This function is intended to construct a pipe from an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a> representing
|
||
an anonymous pipe or a special FIFO file. It will check if the file descriptor
|
||
is a pipe and has read access, set it in non-blocking mode and perform the
|
||
conversion.</p>
|
||
<h5 id="errors-1"><a class="doc-anchor" href="#errors-1">§</a>Errors</h5>
|
||
<p>Fails with <code>io::ErrorKind::InvalidInput</code> if the file descriptor 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-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</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" title="method tokio::runtime::Runtime::enter"><code>Runtime::enter</code></a> function.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_file_unchecked" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#970-972">Source</a><h4 class="code-header">pub fn <a href="#method.from_file_unchecked" class="fn">from_file_unchecked</a>(file: <a class="struct" href="https://doc.rust-lang.org/1.93.1/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/std/fs/struct.File.html" title="struct std::fs::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 class="doc-anchor" href="#examples-1">§</a>Examples</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-2"><a class="doc-anchor" href="#panics-2">§</a>Panics</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" title="method tokio::runtime::Runtime::enter"><code>Runtime::enter</code></a> function.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_owned_fd_unchecked" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#990-994">Source</a><h4 class="code-header">pub fn <a href="#method.from_owned_fd_unchecked" class="fn">from_owned_fd_unchecked</a>(owned_fd: <a class="struct" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd">OwnedFd</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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 an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a> without checking pipe properties.</p>
|
||
<p>This function is intended to construct a pipe from an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a> representing
|
||
an anonymous pipe or a special FIFO file. The conversion assumes nothing about
|
||
the underlying pipe; it is left up to the user to make sure that the file
|
||
descriptor represents the reading end of a pipe and the pipe is set in
|
||
non-blocking mode.</p>
|
||
<h5 id="panics-3"><a class="doc-anchor" href="#panics-3">§</a>Panics</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" title="method tokio::runtime::Runtime::enter"><code>Runtime::enter</code></a> function.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.ready" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1015-1018">Source</a><h4 class="code-header">pub async fn <a href="#method.ready" class="fn">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/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable()</code></a> to check the returned
|
||
ready set for <a href="../../../io/struct.Ready.html#associatedconstant.READABLE" title="associated constant tokio::io::Ready::READABLE"><code>Ready::READABLE</code></a> and <a href="../../../io/struct.Ready.html#associatedconstant.READ_CLOSED" title="associated constant tokio::io::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="struct tokio::io::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 class="doc-anchor" href="#cancel-safety">§</a>Cancel safety</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="toggle method-toggle" open><summary><section id="method.readable" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1064-1067">Source</a><h4 class="code-header">pub async fn <a href="#method.readable" class="fn">readable</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::try_read"><code>try_read()</code></a>.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</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="attr">#[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="toggle method-toggle" open><summary><section id="method.poll_read_ready" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1096-1098">Source</a><h4 class="code-header">pub fn <a href="#method.poll_read_ready" class="fn">poll_read_ready</a>(&self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable</code></a> is not feasible. Where possible, using <a href="struct.Receiver.html#method.readable" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable</code></a> is
|
||
preferred, as this supports polling from multiple tasks at once.</p>
|
||
<h5 id="return-value"><a class="doc-anchor" href="#return-value">§</a>Return value</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-2"><a class="doc-anchor" href="#errors-2">§</a>Errors</h5>
|
||
<p>This function may encounter any standard I/O error except <code>WouldBlock</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_read" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1160-1164">Source</a><h4 class="code-header">pub fn <a href="#method.try_read" class="fn">try_read</a>(&self, buf: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable()</code></a> is used with this function.</p>
|
||
<h5 id="return"><a class="doc-anchor" href="#return">§</a>Return</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 class="doc-anchor" href="#examples-3">§</a>Examples</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="attr">#[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="toggle method-toggle" open><summary><section id="method.try_read_vectored" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1234-1238">Source</a><h4 class="code-header">pub fn <a href="#method.try_read_vectored" class="fn">try_read_vectored</a>(&self, bufs: &mut [<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/io/struct.IoSliceMut.html" title="struct std::io::IoSliceMut">IoSliceMut</a><'_>]) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::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" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable()</code></a> is used with this function.</p>
|
||
<h5 id="return-1"><a class="doc-anchor" href="#return-1">§</a>Return</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 class="doc-anchor" href="#examples-4">§</a>Examples</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="attr">#[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="toggle method-toggle" open><summary><section id="method.try_read_buf" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1297-1315">Source</a><h4 class="code-header">pub fn <a href="#method.try_read_buf" class="fn">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/1.93.1/std/primitive.reference.html">&mut B</a>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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" title="method tokio::net::unix::pipe::Receiver::readable"><code>readable()</code></a> or <a href="struct.Receiver.html#method.ready" title="method tokio::net::unix::pipe::Receiver::ready"><code>ready()</code></a> is used with this function.</p>
|
||
<h5 id="return-2"><a class="doc-anchor" href="#return-2">§</a>Return</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 class="doc-anchor" href="#examples-5">§</a>Examples</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="attr">#[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><details class="toggle method-toggle" open><summary><section id="method.into_blocking_fd" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1322-1326">Source</a><h4 class="code-header">pub fn <a href="#method.into_blocking_fd" class="fn">into_blocking_fd</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd">OwnedFd</a>></h4></section></summary><div class="docblock"><p>Converts the pipe into an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a> in blocking mode.</p>
|
||
<p>This function will deregister this pipe end from the event loop, set
|
||
it in blocking mode and perform the conversion.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_nonblocking_fd" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1333-1341">Source</a><h4 class="code-header">pub fn <a href="#method.into_nonblocking_fd" class="fn">into_nonblocking_fd</a>(self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd">OwnedFd</a>></h4></section></summary><div class="docblock"><p>Converts the pipe into an <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/struct.OwnedFd.html" title="struct std::os::fd::owned::OwnedFd"><code>OwnedFd</code></a> in nonblocking mode.</p>
|
||
<p>This function will deregister this pipe end from the event loop and
|
||
perform the conversion. Returned file descriptor will be in nonblocking
|
||
mode.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AsFd-for-Receiver" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1362-1366">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/1.93.1/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="toggle method-toggle" open><summary><section id="method.as_fd" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1363-1365">Source</a><a href="#method.as_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd" class="fn">as_fd</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/std/os/fd/owned/trait.AsFd.html#tymethod.as_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsRawFd-for-Receiver" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1356-1360">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/1.93.1/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="toggle method-toggle" open><summary><section id="method.as_raw_fd" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1357-1359">Source</a><a href="#method.as_raw_fd" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd" class="fn">as_raw_fd</a>(&self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/std/os/fd/raw/trait.AsRawFd.html#tymethod.as_raw_fd">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsyncRead-for-Receiver" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1344-1354">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="toggle method-toggle" open><summary><section id="method.poll_read" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#1345-1353">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="fn">poll_read</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
buf: &mut <a class="struct" href="../../../io/struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/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="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Receiver" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#860">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/1.93.1/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="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#860">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Receiver" class="impl"><a href="#impl-Freeze-for-Receiver" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::net::unix::pipe::Receiver">Receiver</a></h3></section><section id="impl-RefUnwindSafe-for-Receiver" class="impl"><a href="#impl-RefUnwindSafe-for-Receiver" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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"><a href="#impl-Send-for-Receiver" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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"><a href="#impl-Sync-for-Receiver" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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"><a href="#impl-Unpin-for-Receiver" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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"><a href="#impl-UnwindSafe-for-Receiver" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/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="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/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/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsyncReadExt-for-R" class="impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#1454">Source</a><a href="#impl-AsyncReadExt-for-R" class="anchor">§</a><h3 class="code-header">impl<R> <a class="trait" href="../../../io/trait.AsyncReadExt.html" title="trait tokio::io::AsyncReadExt">AsyncReadExt</a> for R<div class="where">where
|
||
R: <a class="trait" href="../../../io/trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.chain" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#98-104">Source</a><a href="#method.chain" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.chain" class="fn">chain</a><R>(self, next: R) -> <a class="struct" href="../../../io/struct.Chain.html" title="struct tokio::io::Chain">Chain</a><Self, R><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
||
R: <a class="trait" href="../../../io/trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a>,</div></h4></section></summary><div class='docblock'>Creates a new <code>AsyncRead</code> instance that chains this stream with
|
||
<code>next</code>. <a href="../../../io/trait.AsyncReadExt.html#method.chain">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#177-182">Source</a><a href="#method.read" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read" class="fn">read</a><'a>(&'a mut self, buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> Read<'a, Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Pulls some bytes from this source into the specified buffer,
|
||
returning how many bytes were read. <a href="../../../io/trait.AsyncReadExt.html#method.read">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_buf" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#258-264">Source</a><a href="#method.read_buf" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_buf" class="fn">read_buf</a><'a, B>(&'a mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'a mut B</a>) -> ReadBuf<'a, Self, B><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
B: <a class="trait" href="../../../../bytes/buf/buf_mut/trait.BufMut.html" title="trait bytes::buf::buf_mut::BufMut">BufMut</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Pulls some bytes from this source into the specified buffer,
|
||
advancing the buffer’s internal cursor. <a href="../../../io/trait.AsyncReadExt.html#method.read_buf">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_exact" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#323-328">Source</a><a href="#method.read_exact" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_exact" class="fn">read_exact</a><'a>(&'a mut self, buf: &'a mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> ReadExact<'a, Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads the exact number of bytes required to fill <code>buf</code>. <a href="../../../io/trait.AsyncReadExt.html#method.read_exact">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u8" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u8" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u8" class="fn">read_u8</a>(&mut self) -> ReadU8<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 8 bit integer from the underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u8">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i8" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i8" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i8" class="fn">read_i8</a>(&mut self) -> ReadI8<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads a signed 8 bit integer from the underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i8">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u16" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u16" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u16" class="fn">read_u16</a>(&mut self) -> ReadU16<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 16-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u16">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i16" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i16" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i16" class="fn">read_i16</a>(&mut self) -> ReadI16<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads a signed 16-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i16">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u32" class="fn">read_u32</a>(&mut self) -> ReadU32<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 32-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i32" class="fn">read_i32</a>(&mut self) -> ReadI32<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads a signed 32-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u64" class="fn">read_u64</a>(&mut self) -> ReadU64<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 64-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i64" class="fn">read_i64</a>(&mut self) -> ReadI64<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an signed 64-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u128" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u128" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u128" class="fn">read_u128</a>(&mut self) -> ReadU128<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 128-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u128">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i128" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i128" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i128" class="fn">read_i128</a>(&mut self) -> ReadI128<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an signed 128-bit integer in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i128">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_f32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_f32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_f32" class="fn">read_f32</a>(&mut self) -> ReadF32<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an 32-bit floating point type in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_f32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_f64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_f64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_f64" class="fn">read_f64</a>(&mut self) -> ReadF64<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an 64-bit floating point type in big-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_f64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u16_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u16_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u16_le" class="fn">read_u16_le</a>(&mut self) -> ReadU16Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 16-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u16_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i16_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i16_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i16_le" class="fn">read_i16_le</a>(&mut self) -> ReadI16Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads a signed 16-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i16_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u32_le" class="fn">read_u32_le</a>(&mut self) -> ReadU32Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 32-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i32_le" class="fn">read_i32_le</a>(&mut self) -> ReadI32Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads a signed 32-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u64_le" class="fn">read_u64_le</a>(&mut self) -> ReadU64Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 64-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i64_le" class="fn">read_i64_le</a>(&mut self) -> ReadI64Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an signed 64-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_u128_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_u128_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_u128_le" class="fn">read_u128_le</a>(&mut self) -> ReadU128Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an unsigned 128-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_u128_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_i128_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_i128_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_i128_le" class="fn">read_i128_le</a>(&mut self) -> ReadI128Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an signed 128-bit integer in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_i128_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_f32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_f32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_f32_le" class="fn">read_f32_le</a>(&mut self) -> ReadF32Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an 32-bit floating point type in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_f32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_f64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#330-1304">Source</a><a href="#method.read_f64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_f64_le" class="fn">read_f64_le</a>(&mut self) -> ReadF64Le<&mut Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads an 64-bit floating point type in little-endian order from the
|
||
underlying reader. <a href="../../../io/trait.AsyncReadExt.html#method.read_f64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_to_end" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#1354-1359">Source</a><a href="#method.read_to_end" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_to_end" class="fn">read_to_end</a><'a>(&'a mut self, buf: &'a mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>>) -> ReadToEnd<'a, Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads all bytes until EOF in this source, placing them into <code>buf</code>. <a href="../../../io/trait.AsyncReadExt.html#method.read_to_end">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.read_to_string" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#1404-1409">Source</a><a href="#method.read_to_string" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.read_to_string" class="fn">read_to_string</a><'a>(
|
||
&'a mut self,
|
||
dst: &'a mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
) -> ReadToString<'a, Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h4></section></summary><div class='docblock'>Reads all bytes until EOF in this source, appending them to <code>buf</code>. <a href="../../../io/trait.AsyncReadExt.html#method.read_to_string">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.take" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_read_ext.rs.html#1445-1450">Source</a><a href="#method.take" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncReadExt.html#method.take" class="fn">take</a>(self, limit: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../../../io/struct.Take.html" title="struct tokio::io::Take">Take</a><Self><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Creates an adaptor which reads at most <code>limit</code> bytes from it. <a href="../../../io/trait.AsyncReadExt.html#method.take">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">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/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/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="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/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></body></html> |