361 lines
87 KiB
HTML
361 lines
87 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="Writing end of a Unix pipe."><title>Sender 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="#">Sender</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="#">Sender</a></h2><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_write_ready" title="poll_write_ready">poll_write_ready</a></li><li><a href="#method.ready" title="ready">ready</a></li><li><a href="#method.try_write" title="try_write">try_write</a></li><li><a href="#method.try_write_vectored" title="try_write_vectored">try_write_vectored</a></li><li><a href="#method.writable" title="writable">writable</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-AsFd-for-Sender" title="AsFd">AsFd</a></li><li><a href="#impl-AsRawFd-for-Sender" title="AsRawFd">AsRawFd</a></li><li><a href="#impl-AsyncWrite-for-Sender" title="AsyncWrite">AsyncWrite</a></li><li><a href="#impl-Debug-for-Sender" 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-Sender" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Sender" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Sender" title="Send">Send</a></li><li><a href="#impl-Sync-for-Sender" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Sender" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Sender" 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-AsyncWriteExt-for-W" title="AsyncWriteExt">AsyncWriteExt</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">Sender</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#365-367">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Sender { <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>Writing end of a Unix pipe.</p>
|
||
<p>It can be constructed from a FIFO file with <a href="struct.OpenOptions.html#method.open_sender" title="method tokio::net::unix::pipe::OpenOptions::open_sender"><code>OpenOptions::open_sender</code></a>.</p>
|
||
<p>Opening a named pipe for writing involves a few steps.
|
||
Call to <a href="struct.OpenOptions.html#method.open_sender" title="method tokio::net::unix::pipe::OpenOptions::open_sender"><code>OpenOptions::open_sender</code></a> might fail with an error indicating
|
||
different things:</p>
|
||
<ul>
|
||
<li><a href="https://doc.rust-lang.org/1.93.1/std/io/error/enum.ErrorKind.html#variant.NotFound" title="variant std::io::error::ErrorKind::NotFound"><code>io::ErrorKind::NotFound</code></a> - There is no file at the specified path.</li>
|
||
<li><a href="https://doc.rust-lang.org/1.93.1/std/io/error/enum.ErrorKind.html#variant.InvalidInput" title="variant std::io::error::ErrorKind::InvalidInput"><code>io::ErrorKind::InvalidInput</code></a> - The file exists, but it is not a FIFO.</li>
|
||
<li><a href="https://docs.rs/libc/latest/libc/constant.ENXIO.html"><code>ENXIO</code></a> - The file is a FIFO, but no process has it open for reading.
|
||
Sleep for a while and try again.</li>
|
||
<li>Other OS errors not specific to opening FIFO files.</li>
|
||
</ul>
|
||
<p>Opening a <code>Sender</code> from a FIFO file should look like this:</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::time::{<span class="self">self</span>, Duration};
|
||
|
||
<span class="kw">const </span>FIFO_NAME: <span class="kw-2">&</span>str = <span class="string">"path/to/a/fifo"</span>;
|
||
|
||
<span class="comment">// Wait for a reader to open the file.
|
||
</span><span class="kw">let </span>tx = <span class="kw">loop </span>{
|
||
<span class="kw">match </span>pipe::OpenOptions::new().open_sender(FIFO_NAME) {
|
||
<span class="prelude-val">Ok</span>(tx) => <span class="kw">break </span>tx,
|
||
<span class="prelude-val">Err</span>(e) <span class="kw">if </span>e.raw_os_error() == <span class="prelude-val">Some</span>(libc::ENXIO) => {},
|
||
<span class="prelude-val">Err</span>(e) => <span class="kw">return </span><span class="prelude-val">Err</span>(e.into()),
|
||
}
|
||
|
||
time::sleep(Duration::from_millis(<span class="number">50</span>)).<span class="kw">await</span>;
|
||
};</code></pre></div>
|
||
<p>On Linux, it is possible to create a <code>Sender</code> without waiting in a sleeping
|
||
loop. This is done by opening a named pipe in read-write access mode with
|
||
<code>OpenOptions::read_write</code>. This way, a <code>Sender</code> can at the same time hold
|
||
both a writing end and a reading end, and the latter allows to open a FIFO
|
||
without <a href="https://docs.rs/libc/latest/libc/constant.ENXIO.html"><code>ENXIO</code></a> error since the pipe is open for reading as well.</p>
|
||
<p><code>Sender</code> cannot be used to read from a pipe, so in practice the read access
|
||
is only used when a FIFO is opened. However, using a <code>Sender</code> in read-write
|
||
mode <strong>may lead to lost data</strong>, because written data will be dropped by the
|
||
system as soon as all pipe ends are closed. To avoid lost data you have to
|
||
make sure that a reading end has been opened before dropping a <code>Sender</code>.</p>
|
||
<p>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::io::AsyncWriteExt;
|
||
<span class="kw">use </span>tokio::net::unix::pipe;
|
||
|
||
<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>tx = pipe::OpenOptions::new()
|
||
.read_write(<span class="bool-val">true</span>)
|
||
.open_sender(FIFO_NAME)<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Asynchronously write to the pipe before a reader.
|
||
</span>tx.write_all(<span class="string">b"hello world"</span>).<span class="kw">await</span><span class="question-mark">?</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-Sender" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#369-749">Source</a><a href="#impl-Sender" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</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#394-396">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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Sender</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 write 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 write 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#419-434">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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Sender</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 write 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 write 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#474-476">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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Sender</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 write access,
|
||
represents a pipe and is set in non-blocking mode.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</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()
|
||
.write(<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>tx = pipe::Sender::from_file_unchecked(file)<span class="question-mark">?</span>;
|
||
<span class="comment">/* use the Sender */
|
||
</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#494-498">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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a>></h4></section></summary><div class="docblock"><p>Creates a new <code>Sender</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 writing 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#519-522">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.Sender.html#method.writable" title="method tokio::net::unix::pipe::Sender::writable"><code>writable()</code></a> to check the returned
|
||
ready set for <a href="../../../io/struct.Ready.html#associatedconstant.WRITABLE" title="associated constant tokio::io::Ready::WRITABLE"><code>Ready::WRITABLE</code></a> and <a href="../../../io/struct.Ready.html#associatedconstant.WRITE_CLOSED" title="associated constant tokio::io::Ready::WRITE_CLOSED"><code>Ready::WRITE_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 write that fails with <code>WouldBlock</code> or
|
||
<code>Poll::Pending</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.writable" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#564-567">Source</a><h4 class="code-header">pub async fn <a href="#method.writable" class="fn">writable</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 writable.</p>
|
||
<p>This function is equivalent to <code>ready(Interest::WRITABLE)</code> and is usually
|
||
paired with <a href="struct.Sender.html#method.try_write" title="method tokio::net::unix::pipe::Sender::try_write"><code>try_write()</code></a>.</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::io;
|
||
|
||
<span class="attr">#[tokio::main]
|
||
</span><span class="kw">async fn </span>main() -> io::Result<()> {
|
||
<span class="comment">// Open a writing end of a fifo
|
||
</span><span class="kw">let </span>tx = pipe::OpenOptions::new().open_sender(<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 writable
|
||
</span>tx.writable().<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Try to write data, this may still fail with `WouldBlock`
|
||
// if the readiness event is a false positive.
|
||
</span><span class="kw">match </span>tx.try_write(<span class="string">b"hello world"</span>) {
|
||
<span class="prelude-val">Ok</span>(n) => {
|
||
<span class="kw">break</span>;
|
||
}
|
||
<span class="prelude-val">Err</span>(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.poll_write_ready" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#596-598">Source</a><h4 class="code-header">pub fn <a href="#method.poll_write_ready" class="fn">poll_write_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 write readiness.</p>
|
||
<p>If the pipe is not currently ready for writing, this method will
|
||
store a clone of the <code>Waker</code> from the provided <code>Context</code>. When the pipe
|
||
becomes ready for writing, <code>Waker::wake</code> will be called on the waker.</p>
|
||
<p>Note that on multiple calls to <code>poll_write_ready</code> or <code>poll_write</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.Sender.html#method.writable" title="method tokio::net::unix::pipe::Sender::writable"><code>writable</code></a> is not feasible. Where possible, using <a href="struct.Sender.html#method.writable" title="method tokio::net::unix::pipe::Sender::writable"><code>writable</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 writing.</li>
|
||
<li><code>Poll::Ready(Ok(()))</code> if the pipe is ready for writing.</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_write" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#653-657">Source</a><h4 class="code-header">pub fn <a href="#method.try_write" class="fn">try_write</a>(&self, buf: &[<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 write a buffer to the pipe, returning how many bytes were
|
||
written.</p>
|
||
<p>The function will attempt to write the entire contents of <code>buf</code>, but
|
||
only part of the buffer may be written. If the length of <code>buf</code> is not
|
||
greater than <code>PIPE_BUF</code> (an OS constant, 4096 under Linux), then the
|
||
write is guaranteed to be atomic, i.e. either the entire content of
|
||
<code>buf</code> will be written or this method will fail with <code>WouldBlock</code>. There
|
||
is no such guarantee if <code>buf</code> is larger than <code>PIPE_BUF</code>.</p>
|
||
<p>This function is usually paired with <a href="struct.Sender.html#method.writable" title="method tokio::net::unix::pipe::Sender::writable"><code>writable</code></a>.</p>
|
||
<h5 id="return"><a class="doc-anchor" href="#return">§</a>Return</h5>
|
||
<p>If data is successfully written, <code>Ok(n)</code> is returned, where <code>n</code> is the
|
||
number of bytes written. If the pipe is not ready to write data,
|
||
<code>Err(io::ErrorKind::WouldBlock)</code> is returned.</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 writing end of a fifo
|
||
</span><span class="kw">let </span>tx = pipe::OpenOptions::new().open_sender(<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 writable
|
||
</span>tx.writable().<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Try to write data, this may still fail with `WouldBlock`
|
||
// if the readiness event is a false positive.
|
||
</span><span class="kw">match </span>tx.try_write(<span class="string">b"hello world"</span>) {
|
||
<span class="prelude-val">Ok</span>(n) => {
|
||
<span class="kw">break</span>;
|
||
}
|
||
<span class="prelude-val">Err</span>(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_write_vectored" class="method"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#719-723">Source</a><h4 class="code-header">pub fn <a href="#method.try_write_vectored" class="fn">try_write_vectored</a>(&self, buf: &[<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</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 write several buffers to the pipe, returning how many bytes
|
||
were written.</p>
|
||
<p>Data is written from each buffer in order, with the final buffer read
|
||
from possible being only partially consumed. This method behaves
|
||
equivalently to a single call to <a href="struct.Sender.html#method.try_write" title="method tokio::net::unix::pipe::Sender::try_write"><code>try_write()</code></a> with concatenated
|
||
buffers.</p>
|
||
<p>If the total length of buffers is not greater than <code>PIPE_BUF</code> (an OS
|
||
constant, 4096 under Linux), then the write is guaranteed to be atomic,
|
||
i.e. either the entire contents of buffers will be written or this
|
||
method will fail with <code>WouldBlock</code>. There is no such guarantee if the
|
||
total length of buffers is greater than <code>PIPE_BUF</code>.</p>
|
||
<p>This function is usually paired with <a href="struct.Sender.html#method.writable" title="method tokio::net::unix::pipe::Sender::writable"><code>writable</code></a>.</p>
|
||
<h5 id="return-1"><a class="doc-anchor" href="#return-1">§</a>Return</h5>
|
||
<p>If data is successfully written, <code>Ok(n)</code> is returned, where <code>n</code> is the
|
||
number of bytes written. If the pipe is not ready to write 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 writing end of a fifo
|
||
</span><span class="kw">let </span>tx = pipe::OpenOptions::new().open_sender(<span class="string">"path/to/a/fifo"</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let </span>bufs = [io::IoSlice::new(<span class="string">b"hello "</span>), io::IoSlice::new(<span class="string">b"world"</span>)];
|
||
|
||
<span class="kw">loop </span>{
|
||
<span class="comment">// Wait for the pipe to be writable
|
||
</span>tx.writable().<span class="kw">await</span><span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// Try to write data, this may still fail with `WouldBlock`
|
||
// if the readiness event is a false positive.
|
||
</span><span class="kw">match </span>tx.try_write_vectored(<span class="kw-2">&</span>bufs) {
|
||
<span class="prelude-val">Ok</span>(n) => {
|
||
<span class="kw">break</span>;
|
||
}
|
||
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == io::ErrorKind::WouldBlock => {
|
||
<span class="kw">continue</span>;
|
||
}
|
||
<span class="prelude-val">Err</span>(e) => {
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(e.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#729-733">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#740-748">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. The 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-Sender" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#787-791">Source</a><a href="#impl-AsFd-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</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#788-790">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-Sender" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#781-785">Source</a><a href="#impl-AsRawFd-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</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#782-784">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-AsyncWrite-for-Sender" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#751-779">Source</a><a href="#impl-AsyncWrite-for-Sender" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../../../io/trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.poll_write" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#752-758">Source</a><a href="#method.poll_write" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_write" class="fn">poll_write</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: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</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.usize.html">usize</a>>></h4></section></summary><div class='docblock'>Attempt to write bytes from <code>buf</code> into the object. <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_write">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_write_vectored" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#760-766">Source</a><a href="#method.poll_write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWrite.html#method.poll_write_vectored" class="fn">poll_write_vectored</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><'_>,
|
||
bufs: &[<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</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.usize.html">usize</a>>></h4></section></summary><div class='docblock'>Like <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_write" title="method tokio::io::AsyncWrite::poll_write"><code>poll_write</code></a>, except that it writes from a slice of buffers. <a href="../../../io/trait.AsyncWrite.html#method.poll_write_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.is_write_vectored" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#768-770">Source</a><a href="#method.is_write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWrite.html#method.is_write_vectored" class="fn">is_write_vectored</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Determines if this writer has an efficient <a href="../../../io/trait.AsyncWrite.html#method.poll_write_vectored" title="method tokio::io::AsyncWrite::poll_write_vectored"><code>poll_write_vectored</code></a>
|
||
implementation. <a href="../../../io/trait.AsyncWrite.html#method.is_write_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_flush" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#772-774">Source</a><a href="#method.poll_flush" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_flush" class="fn">poll_flush</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>, _: &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'>Attempts to flush the object, ensuring that any buffered data reach
|
||
their destination. <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_flush">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_shutdown" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#776-778">Source</a><a href="#method.poll_shutdown" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_shutdown" class="fn">poll_shutdown</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>, _: &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'>Initiates or attempts to shut down this writer, returning success when
|
||
the I/O connection has completely shut down. <a href="../../../io/trait.AsyncWrite.html#tymethod.poll_shutdown">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Sender" class="impl"><a class="src rightside" href="../../../../src/tokio/net/unix/pipe.rs.html#364">Source</a><a href="#impl-Debug-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</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#364">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-Sender" class="impl"><a href="#impl-Freeze-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section><section id="impl-RefUnwindSafe-for-Sender" class="impl"><a href="#impl-RefUnwindSafe-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section><section id="impl-Send-for-Sender" class="impl"><a href="#impl-Send-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section><section id="impl-Sync-for-Sender" class="impl"><a href="#impl-Sync-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section><section id="impl-Unpin-for-Sender" class="impl"><a href="#impl-Unpin-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</a></h3></section><section id="impl-UnwindSafe-for-Sender" class="impl"><a href="#impl-UnwindSafe-for-Sender" 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.Sender.html" title="struct tokio::net::unix::pipe::Sender">Sender</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-AsyncWriteExt-for-W" class="impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#1332">Source</a><a href="#impl-AsyncWriteExt-for-W" class="anchor">§</a><h3 class="code-header">impl<W> <a class="trait" href="../../../io/trait.AsyncWriteExt.html" title="trait tokio::io::AsyncWriteExt">AsyncWriteExt</a> for W<div class="where">where
|
||
W: <a class="trait" href="../../../io/trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</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.write" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#130-135">Source</a><a href="#method.write" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write" class="fn">write</a><'a>(&'a mut self, src: &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> Write<'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'>Writes a buffer into this writer, returning how many bytes were
|
||
written. <a href="../../../io/trait.AsyncWriteExt.html#method.write">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_vectored" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#182-187">Source</a><a href="#method.write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_vectored" class="fn">write_vectored</a><'a, 'b>(
|
||
&'a mut self,
|
||
bufs: &'a [<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'b>],
|
||
) -> WriteVectored<'a, 'b, 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'>Like <a href="../../../io/trait.AsyncWriteExt.html#method.write" title="method tokio::io::AsyncWriteExt::write"><code>write</code></a>, except that it writes from a slice of buffers. <a href="../../../io/trait.AsyncWriteExt.html#method.write_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_buf" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#266-272">Source</a><a href="#method.write_buf" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_buf" class="fn">write_buf</a><'a, B>(&'a mut self, src: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'a mut B</a>) -> WriteBuf<'a, Self, B><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> + <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_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>,</div></h4></section></summary><div class='docblock'>Writes a buffer into this writer, advancing the buffer’s internal
|
||
cursor. <a href="../../../io/trait.AsyncWriteExt.html#method.write_buf">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_all_buf" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#334-340">Source</a><a href="#method.write_all_buf" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_all_buf" class="fn">write_all_buf</a><'a, B>(
|
||
&'a mut self,
|
||
src: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'a mut B</a>,
|
||
) -> WriteAllBuf<'a, Self, B><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> + <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_impl/trait.Buf.html" title="trait bytes::buf::buf_impl::Buf">Buf</a>,</div></h4></section></summary><div class='docblock'>Attempts to write an entire buffer into this writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_all_buf">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_all" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#387-392">Source</a><a href="#method.write_all" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_all" class="fn">write_all</a><'a>(&'a mut self, src: &'a [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> WriteAll<'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'>Attempts to write an entire buffer into this writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_all">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u8" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u8" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u8" class="fn">write_u8</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>) -> WriteU8<&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'>Writes an unsigned 8-bit integer to the underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u8">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i8" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i8" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i8" class="fn">write_i8</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i8.html">i8</a>) -> WriteI8<&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'>Writes a signed 8-bit integer to the underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i8">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u16" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u16" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u16" class="fn">write_u16</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u16.html">u16</a>) -> WriteU16<&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'>Writes an unsigned 16-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u16">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i16" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i16" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i16" class="fn">write_i16</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i16.html">i16</a>) -> WriteI16<&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'>Writes a signed 16-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i16">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u32" class="fn">write_u32</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> WriteU32<&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'>Writes an unsigned 32-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i32" class="fn">write_i32</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a>) -> WriteI32<&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'>Writes a signed 32-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u64" class="fn">write_u64</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>) -> WriteU64<&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'>Writes an unsigned 64-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i64" class="fn">write_i64</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i64.html">i64</a>) -> WriteI64<&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'>Writes an signed 64-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u128" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u128" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u128" class="fn">write_u128</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a>) -> WriteU128<&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'>Writes an unsigned 128-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u128">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i128" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i128" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i128" class="fn">write_i128</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i128.html">i128</a>) -> WriteI128<&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'>Writes an signed 128-bit integer in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i128">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_f32" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_f32" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_f32" class="fn">write_f32</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a>) -> WriteF32<&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'>Writes an 32-bit floating point type in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_f32">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_f64" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_f64" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_f64" class="fn">write_f64</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a>) -> WriteF64<&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'>Writes an 64-bit floating point type in big-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_f64">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u16_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u16_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u16_le" class="fn">write_u16_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u16.html">u16</a>) -> WriteU16Le<&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'>Writes an unsigned 16-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u16_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i16_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i16_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i16_le" class="fn">write_i16_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i16.html">i16</a>) -> WriteI16Le<&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'>Writes a signed 16-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i16_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u32_le" class="fn">write_u32_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> WriteU32Le<&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'>Writes an unsigned 32-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i32_le" class="fn">write_i32_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a>) -> WriteI32Le<&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'>Writes a signed 32-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u64_le" class="fn">write_u64_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>) -> WriteU64Le<&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'>Writes an unsigned 64-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i64_le" class="fn">write_i64_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i64.html">i64</a>) -> WriteI64Le<&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'>Writes an signed 64-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_u128_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_u128_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_u128_le" class="fn">write_u128_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a>) -> WriteU128Le<&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'>Writes an unsigned 128-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_u128_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_i128_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_i128_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_i128_le" class="fn">write_i128_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i128.html">i128</a>) -> WriteI128Le<&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'>Writes an signed 128-bit integer in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_i128_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_f32_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_f32_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_f32_le" class="fn">write_f32_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a>) -> WriteF32Le<&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'>Writes an 32-bit floating point type in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_f32_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_f64_le" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#394-1236">Source</a><a href="#method.write_f64_le" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.write_f64_le" class="fn">write_f64_le</a>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a>) -> WriteF64Le<&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'>Writes an 64-bit floating point type in little-endian order to the
|
||
underlying writer. <a href="../../../io/trait.AsyncWriteExt.html#method.write_f64_le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flush" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#1281-1286">Source</a><a href="#method.flush" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.flush" class="fn">flush</a>(&mut self) -> Flush<'_, 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'>Flushes this output stream, ensuring that all intermediately buffered
|
||
contents reach their destination. <a href="../../../io/trait.AsyncWriteExt.html#method.flush">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.shutdown" class="method trait-impl"><a class="src rightside" href="../../../../src/tokio/io/util/async_write_ext.rs.html#1323-1328">Source</a><a href="#method.shutdown" class="anchor">§</a><h4 class="code-header">fn <a href="../../../io/trait.AsyncWriteExt.html#method.shutdown" class="fn">shutdown</a>(&mut self) -> Shutdown<'_, 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'>Shuts down the output stream, ensuring that the value can be dropped
|
||
cleanly. <a href="../../../io/trait.AsyncWriteExt.html#method.shutdown">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> |