132 lines
107 KiB
HTML
132 lines
107 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="API documentation for the Rust `AsyncWrite` trait in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, AsyncWrite"><title>tokio::io::AsyncWrite - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tokio/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait AsyncWrite</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.poll_flush">poll_flush</a><a href="#tymethod.poll_shutdown">poll_shutdown</a><a href="#tymethod.poll_write">poll_write</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_write_vectored">is_write_vectored</a><a href="#method.poll_write_vectored">poll_write_vectored</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-AsyncWrite-for-%26%27_%20mut%20T">&'_ mut T</a><a href="#impl-AsyncWrite-for-Box%3CT%3E">Box<T></a><a href="#impl-AsyncWrite-for-Cursor%3C%26%27_%20mut%20Vec%3Cu8%3E%3E">Cursor<&'_ mut Vec<u8>></a><a href="#impl-AsyncWrite-for-Cursor%3C%26%27_%20mut%20%5Bu8%5D%3E">Cursor<&'_ mut [u8]></a><a href="#impl-AsyncWrite-for-Cursor%3CBox%3C%5Bu8%5D%3E%3E">Cursor<Box<[u8]>></a><a href="#impl-AsyncWrite-for-Cursor%3CVec%3Cu8%3E%3E">Cursor<Vec<u8>></a><a href="#impl-AsyncWrite-for-Pin%3CP%3E">Pin<P></a><a href="#impl-AsyncWrite-for-Vec%3Cu8%3E">Vec<u8></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">tokio</a>::<wbr><a href="index.html">io</a></p><script>window.sidebarCurrent = {name: "AsyncWrite", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
|||
|
|
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tokio/io/async_write.rs.html#45-179" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">tokio</a>::<wbr><a href="index.html">io</a>::<wbr><a class="trait" href="">AsyncWrite</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait AsyncWrite {
|
|||
|
|
fn <a href="#tymethod.poll_write" class="fnname">poll_write</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>>;
|
|||
|
|
<div class="item-spacer"></div> fn <a href="#tymethod.poll_flush" class="fnname">poll_flush</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>>;
|
|||
|
|
<div class="item-spacer"></div> fn <a href="#tymethod.poll_shutdown" class="fnname">poll_shutdown</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>>;
|
|||
|
|
|
|||
|
|
fn <a href="#method.poll_write_vectored" class="fnname">poll_write_vectored</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> bufs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="https://doc.rust-lang.org/nightly/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>> { ... }
|
|||
|
|
<div class="item-spacer"></div> fn <a href="#method.is_write_vectored" class="fnname">is_write_vectored</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|||
|
|
}</pre></div><div class="docblock"><p>Writes bytes asynchronously.</p>
|
|||
|
|
<p>The trait inherits from <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html"><code>std::io::Write</code></a> and indicates that an I/O object is
|
|||
|
|
<strong>nonblocking</strong>. All non-blocking I/O objects must return an error when
|
|||
|
|
bytes cannot be written instead of blocking the current thread.</p>
|
|||
|
|
<p>Specifically, this means that the <a href="../../tokio/io/trait.AsyncWrite.html#tymethod.poll_write"><code>poll_write</code></a> function will return one of
|
|||
|
|
the following:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Ready(Ok(n))</code> means that <code>n</code> bytes of data was immediately
|
|||
|
|
written.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Pending</code> means that no data was written from the buffer
|
|||
|
|
provided. The I/O object is not currently writable but may become writable
|
|||
|
|
in the future. Most importantly, <strong>the current future's task is scheduled
|
|||
|
|
to get unparked when the object is writable</strong>. This means that like
|
|||
|
|
<code>Future::poll</code> you'll receive a notification when the I/O object is
|
|||
|
|
writable again.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Ready(Err(e))</code> for other errors are standard I/O errors coming from the
|
|||
|
|
underlying object.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>This trait importantly means that the <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html#tymethod.write"><code>write</code></a> method only works in
|
|||
|
|
the context of a future's task. The object may panic if used outside of a task.</p>
|
|||
|
|
<p>Note that this trait also represents that the <a href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html#tymethod.flush"><code>Write::flush</code></a> method
|
|||
|
|
works very similarly to the <code>write</code> method, notably that <code>Ok(())</code> means that the
|
|||
|
|
writer has successfully been flushed, a "would block" error means that the
|
|||
|
|
current task is ready to receive a notification when flushing can make more
|
|||
|
|
progress, and otherwise normal errors can happen as well.</p>
|
|||
|
|
<p>Utilities for working with <code>AsyncWrite</code> values are provided by
|
|||
|
|
<a href="crate::io::AsyncWriteExt"><code>AsyncWriteExt</code></a>.</p>
|
|||
|
|
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.poll_write" class="method"><code>fn <a href="#tymethod.poll_write" class="fnname">poll_write</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code></h3><div class="docblock"><p>Attempt to write bytes from <code>buf</code> into the object.</p>
|
|||
|
|
<p>On success, returns <code>Poll::Ready(Ok(num_bytes_written))</code>.</p>
|
|||
|
|
<p>If the object is not ready for writing, the method returns
|
|||
|
|
<code>Poll::Pending</code> and arranges for the current task (via
|
|||
|
|
<code>cx.waker()</code>) to receive a notification when the object becomes
|
|||
|
|
writable or is closed.</p>
|
|||
|
|
</div><h3 id="tymethod.poll_flush" class="method"><code>fn <a href="#tymethod.poll_flush" class="fnname">poll_flush</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code></h3><div class="docblock"><p>Attempts to flush the object, ensuring that any buffered data reach
|
|||
|
|
their destination.</p>
|
|||
|
|
<p>On success, returns <code>Poll::Ready(Ok(()))</code>.</p>
|
|||
|
|
<p>If flushing cannot immediately complete, this method returns
|
|||
|
|
<code>Poll::Pending</code> and arranges for the current task (via
|
|||
|
|
<code>cx.waker()</code>) to receive a notification when the object can make
|
|||
|
|
progress towards flushing.</p>
|
|||
|
|
</div><h3 id="tymethod.poll_shutdown" class="method"><code>fn <a href="#tymethod.poll_shutdown" class="fnname">poll_shutdown</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code></h3><div class="docblock"><p>Initiates or attempts to shut down this writer, returning success when
|
|||
|
|
the I/O connection has completely shut down.</p>
|
|||
|
|
<p>This method is intended to be used for asynchronous shutdown of I/O
|
|||
|
|
connections. For example this is suitable for implementing shutdown of a
|
|||
|
|
TLS connection or calling <code>TcpStream::shutdown</code> on a proxied connection.
|
|||
|
|
Protocols sometimes need to flush out final pieces of data or otherwise
|
|||
|
|
perform a graceful shutdown handshake, reading/writing more data as
|
|||
|
|
appropriate. This method is the hook for such protocols to implement the
|
|||
|
|
graceful shutdown logic.</p>
|
|||
|
|
<p>This <code>shutdown</code> method is required by implementers of the
|
|||
|
|
<code>AsyncWrite</code> trait. Wrappers typically just want to proxy this call
|
|||
|
|
through to the wrapped type, and base types will typically implement
|
|||
|
|
shutdown logic here or just return <code>Ok(().into())</code>. Note that if you're
|
|||
|
|
wrapping an underlying <code>AsyncWrite</code> a call to <code>shutdown</code> implies that
|
|||
|
|
transitively the entire stream has been shut down. After your wrapper's
|
|||
|
|
shutdown logic has been executed you should shut down the underlying
|
|||
|
|
stream.</p>
|
|||
|
|
<p>Invocation of a <code>shutdown</code> implies an invocation of <code>flush</code>. Once this
|
|||
|
|
method returns <code>Ready</code> it implies that a flush successfully happened
|
|||
|
|
before the shutdown happened. That is, callers don't need to call
|
|||
|
|
<code>flush</code> before calling <code>shutdown</code>. They can rely that by calling
|
|||
|
|
<code>shutdown</code> any pending buffered data will be written out.</p>
|
|||
|
|
<h1 id="return-value" class="section-header"><a href="#return-value">Return value</a></h1>
|
|||
|
|
<p>This function returns a <code>Poll<io::Result<()>></code> classified as such:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Ready(Ok(()))</code> - indicates that the connection was
|
|||
|
|
successfully shut down and is now safe to deallocate/drop/close
|
|||
|
|
resources associated with it. This method means that the current task
|
|||
|
|
will no longer receive any notifications due to this method and the
|
|||
|
|
I/O object itself is likely no longer usable.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Pending</code> - indicates that shutdown is initiated but could
|
|||
|
|
not complete just yet. This may mean that more I/O needs to happen to
|
|||
|
|
continue this shutdown operation. The current task is scheduled to
|
|||
|
|
receive a notification when it's otherwise ready to continue the
|
|||
|
|
shutdown operation. When woken up this method should be called again.</p>
|
|||
|
|
</li>
|
|||
|
|
<li>
|
|||
|
|
<p><code>Poll::Ready(Err(e))</code> - indicates a fatal error has happened with shutdown,
|
|||
|
|
indicating that the shutdown operation did not complete successfully.
|
|||
|
|
This typically means that the I/O object is no longer usable.</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
|||
|
|
<p>This function can return normal I/O errors through <code>Err</code>, described
|
|||
|
|
above. Additionally this method may also render the underlying
|
|||
|
|
<code>Write::write</code> method no longer usable (e.g. will return errors in the
|
|||
|
|
future). It's recommended that once <code>shutdown</code> is called the
|
|||
|
|
<code>write</code> method is no longer called.</p>
|
|||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|||
|
|
<p>This function will panic if not called within the context of a future's
|
|||
|
|
task.</p>
|
|||
|
|
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.poll_write_vectored" class="method"><code>fn <a href="#method.poll_write_vectored" class="fnname">poll_write_vectored</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> bufs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="https://doc.rust-lang.org/nightly/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>></code></h3><div class="docblock"><p>Like <a href="../../tokio/io/trait.AsyncWrite.html#tymethod.poll_write"><code>poll_write</code></a>, except that it writes from a slice of buffers.</p>
|
|||
|
|
<p>Data is copied from each buffer in order, with the final buffer
|
|||
|
|
read from possibly being only partially consumed. This method must
|
|||
|
|
behave as a call to <a href="https://doc.rust-lang.org/nightly/core/macro.write.html" title="write"><code>write</code></a> with the buffers concatenated would.</p>
|
|||
|
|
<p>The default implementation calls <a href="../../tokio/io/trait.AsyncWrite.html#tymethod.poll_write"><code>poll_write</code></a> with either the first nonempty
|
|||
|
|
buffer provided, or an empty one if none exists.</p>
|
|||
|
|
<p>On success, returns <code>Poll::Ready(Ok(num_bytes_written))</code>.</p>
|
|||
|
|
<p>If the object is not ready for writing, the method returns
|
|||
|
|
<code>Poll::Pending</code> and arranges for the current task (via
|
|||
|
|
<code>cx.waker()</code>) to receive a notification when the object becomes
|
|||
|
|
writable or is closed.</p>
|
|||
|
|
<h1 id="note" class="section-header"><a href="#note">Note</a></h1>
|
|||
|
|
<p>This should be implemented as a single "atomic" write action. If any
|
|||
|
|
data has been partially written, it is wrong to return an error or
|
|||
|
|
pending.</p>
|
|||
|
|
</div><h3 id="method.is_write_vectored" class="method"><code>fn <a href="#method.is_write_vectored" class="fnname">is_write_vectored</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class="docblock"><p>Determines if this writer has an efficient <a href="../../tokio/io/trait.AsyncWrite.html#method.poll_write_vectored"><code>poll_write_vectored</code></a>
|
|||
|
|
implementation.</p>
|
|||
|
|
<p>If a writer does not override the default <a href="../../tokio/io/trait.AsyncWrite.html#method.poll_write_vectored"><code>poll_write_vectored</code></a>
|
|||
|
|
implementation, code using it may want to avoid the method all together
|
|||
|
|
and coalesce writes into a single buffer for higher performance.</p>
|
|||
|
|
<p>The default implementation returns <code>false</code>.</p>
|
|||
|
|
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-AsyncWrite-for-Box%3CT%3E" class="impl"><code class="in-band">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../tokio/io/trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="../../tokio/io/trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></code><a href="#impl-AsyncWrite-for-Box%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/tokio/io/async_write.rs.html#213-215" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.poll_write" class="method hidden"><code>fn <a href="#method.poll_write" class="fnname">poll_write</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>></code><a class="srclink" href="../../src/tokio/io/async_write.rs.html#214" title="goto source code">[src]</a></h4><h4 id="method.poll_write_vectored-1" class="method hidden"><code>fn <a href="#method.poll_write_vectored" class="fnname">poll_write_vectored</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>, <br> bufs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="struct" href="https://doc.rust-lang.org/nightly/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>></code><a class="srclink" href="../../src/tokio/io/async_write.rs.html#214" title="goto source code">[src]</a></h4><h4 id="method.is_write_vectored-1" class="method hidden"><code>fn <a href="#m
|