| <!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="The readable half of an object returned from `AsyncRead::split`."><meta name="keywords" content="rust, rustlang, rust-lang, ReadHalf"><title>ReadHalf in futures::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ReadHalf</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.reunite">reunite</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsyncRead-for-ReadHalf%3CR%3E">AsyncRead</a></li><li><a href="#impl-Debug-for-ReadHalf%3CT%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ReadHalf%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-ReadHalf%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-ReadHalf%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-ReadHalf%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ReadHalf%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ReadHalf%3CT%3E">Any</a></li><li><a href="#impl-AsyncReadExt-for-ReadHalf%3CT%3E">AsyncReadExt</a></li><li><a href="#impl-Borrow%3CT%3E-for-ReadHalf%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ReadHalf%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ReadHalf%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ReadHalf%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-ReadHalf%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ReadHalf%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In futures::io</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">futures</a>::<wbr><a href="index.html">io</a>::<wbr><a class="struct" href="#">ReadHalf</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/futures_util/io/split.rs.html#11">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ReadHalf<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The readable half of an object returned from <code>AsyncRead::split</code>.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ReadHalf%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#34">source</a><a href="#impl-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T><span class="where fmt-newline">where<br> T: Unpin,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reunite" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#38">source</a><h4 class="code-header">pub fn <a href="#method.reunite" class="fnname">reunite</a>(self, other: <a class="struct" href="struct.WriteHalf.html" title="struct futures::io::WriteHalf">WriteHalf</a><T>) -> Result<T, <a class="struct" href="struct.ReuniteError.html" title="struct futures::io::ReuniteError">ReuniteError</a><T>></h4></section></summary><div class="docblock"><p>Attempts to put the two “halves” of a split <code>AsyncRead + AsyncWrite</code> back |
| together. Succeeds only if the <code>ReadHalf<T></code> and <code>WriteHalf<T></code> are |
| a matching pair originating from the same call to <code>AsyncReadExt::split</code>.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncRead-for-ReadHalf%3CR%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#54">source</a><a href="#impl-AsyncRead-for-ReadHalf%3CR%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><R><span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#55-59">source</a><a href="#method.poll_read" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncRead.html#tymethod.poll_read" class="fnname">poll_read</a>(<br> self: Pin<&mut <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><R>>,<br> cx: &mut <a class="struct" href="../task/struct.Context.html" title="struct futures::task::Context">Context</a><'_>,<br> buf: &mut [u8]<br>) -> <a class="enum" href="../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>></h4></section></summary><div class='docblock'>Attempt to read from the <code>AsyncRead</code> into <code>buf</code>. <a href="trait.AsyncRead.html#tymethod.poll_read">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#63-67">source</a><a href="#method.poll_read_vectored" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncRead.html#method.poll_read_vectored" class="fnname">poll_read_vectored</a>(<br> self: Pin<&mut <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><R>>,<br> cx: &mut <a class="struct" href="../task/struct.Context.html" title="struct futures::task::Context">Context</a><'_>,<br> bufs: &mut [<a class="struct" href="struct.IoSliceMut.html" title="struct futures::io::IoSliceMut">IoSliceMut</a><'_>]<br>) -> <a class="enum" href="../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a><Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>></h4></section></summary><div class='docblock'>Attempt to read from the <code>AsyncRead</code> into <code>bufs</code> using vectored |
| IO operations. <a href="trait.AsyncRead.html#method.poll_read_vectored">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ReadHalf%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#10">source</a><a href="#impl-Debug-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Debug for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T><span class="where fmt-newline">where<br> T: Debug,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/split.rs.html#10">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !RefUnwindSafe for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T></h3></section><section id="impl-Send-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Unpin-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Unpin for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T></h3></section><section id="impl-UnwindSafe-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !UnwindSafe for <a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><T></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncReadExt-for-ReadHalf%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#398">source</a><a href="#impl-AsyncReadExt-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="trait.AsyncReadExt.html" title="trait futures::io::AsyncReadExt">AsyncReadExt</a> for R<span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.chain" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#172-175">source</a><a href="#method.chain" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.chain" class="fnname">chain</a><R>(self, next: R) -> <a class="struct" href="struct.Chain.html" title="struct futures::io::Chain">Chain</a><Self, R><span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a>,</span></h4></section></summary><div class='docblock'>Creates an adaptor which will chain this stream with another. <a href="trait.AsyncReadExt.html#method.chain">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#204-206">source</a><a href="#method.read" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.read" class="fnname">read</a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="struct.Read.html" title="struct futures::io::Read">Read</a><'a, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.Read.html" title="struct futures::io::Read">Read</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R> <a class="trait" href="../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="struct.Read.html" title="struct futures::io::Read">Read</a><'_, R><span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Tries to read some bytes directly into the given <code>buf</code> in asynchronous |
| manner, returning a future type. <a href="trait.AsyncReadExt.html#method.read">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#216-218">source</a><a href="#method.read_vectored" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.read_vectored" class="fnname">read_vectored</a>(<br> &'a mut self,<br> bufs: &'a mut [<a class="struct" href="struct.IoSliceMut.html" title="struct futures::io::IoSliceMut">IoSliceMut</a><'a>]<br>) -> <a class="struct" href="struct.ReadVectored.html" title="struct futures::io::ReadVectored">ReadVectored</a><'a, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.ReadVectored.html" title="struct futures::io::ReadVectored">ReadVectored</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R> <a class="trait" href="../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="struct.ReadVectored.html" title="struct futures::io::ReadVectored">ReadVectored</a><'_, R><span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read from the <code>AsyncRead</code> into <code>bufs</code> using vectored |
| IO operations. <a href="trait.AsyncReadExt.html#method.read_vectored">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_exact" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#260-262">source</a><a href="#method.read_exact" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.read_exact" class="fnname">read_exact</a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="struct.ReadExact.html" title="struct futures::io::ReadExact">ReadExact</a><'a, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.ReadExact.html" title="struct futures::io::ReadExact">ReadExact</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R> <a class="trait" href="../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="struct.ReadExact.html" title="struct futures::io::ReadExact">ReadExact</a><'_, R><span class="where fmt-newline">where<br> R: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result<(), <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read exactly enough bytes to fill <code>buf</code>, |
| returning an error if end of file (EOF) is hit sooner. <a href="trait.AsyncReadExt.html#method.read_exact">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_end" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#286-288">source</a><a href="#method.read_to_end" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.read_to_end" class="fnname">read_to_end</a>(&'a mut self, buf: &'a mut Vec<u8, Global>) -> <a class="struct" href="struct.ReadToEnd.html" title="struct futures::io::ReadToEnd">ReadToEnd</a><'a, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.ReadToEnd.html" title="struct futures::io::ReadToEnd">ReadToEnd</a><'_, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="struct.ReadToEnd.html" title="struct futures::io::ReadToEnd">ReadToEnd</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes from this <code>AsyncRead</code>. <a href="trait.AsyncReadExt.html#method.read_to_end">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_string" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#312-314">source</a><a href="#method.read_to_string" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.read_to_string" class="fnname">read_to_string</a>(&'a mut self, buf: &'a mut String) -> <a class="struct" href="struct.ReadToString.html" title="struct futures::io::ReadToString">ReadToString</a><'a, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="struct.ReadToString.html" title="struct futures::io::ReadToString">ReadToString</a><'_, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="struct.ReadToString.html" title="struct futures::io::ReadToString">ReadToString</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="trait.AsyncRead.html" title="trait futures::io::AsyncRead">AsyncRead</a> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result<usize, <a class="struct" href="struct.Error.html" title="struct futures::io::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes from this <code>AsyncRead</code>. <a href="trait.AsyncReadExt.html#method.read_to_string">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#348-350">source</a><a href="#method.split" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.split" class="fnname">split</a>(self) -> (<a class="struct" href="struct.ReadHalf.html" title="struct futures::io::ReadHalf">ReadHalf</a><Self>, <a class="struct" href="struct.WriteHalf.html" title="struct futures::io::WriteHalf">WriteHalf</a><Self>)<span class="where fmt-newline">where<br> Self: <a class="trait" href="trait.AsyncWrite.html" title="trait futures::io::AsyncWrite">AsyncWrite</a>,</span></h4></section></summary><div class='docblock'>Helper method for splitting this read/write object into two halves. <a href="trait.AsyncReadExt.html#method.split">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#375-377">source</a><a href="#method.take" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncReadExt.html#method.take" class="fnname">take</a>(self, limit: u64) -> <a class="struct" href="struct.Take.html" title="struct futures::io::Take">Take</a><Self></h4></section></summary><div class='docblock'>Creates an AsyncRead adapter which will read at most <code>limit</code> bytes |
| from the underlying reader. <a href="trait.AsyncReadExt.html#method.take">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ReadHalf%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-ReadHalf%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |