158 lines
59 KiB
HTML
158 lines
59 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="A unified `Stream` and `Sink` interface to an underlying I/O object, using the `Encoder` and `Decoder` traits to encode and decode frames."><title>Framed in tokio_util::codec - 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_util" 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="#">Framed</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio_util/index.html">tokio_<wbr>util</a><span class="version">0.7.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Framed</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#cancellation-safety" title="Cancellation safety">Cancellation safety</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.backpressure_boundary" title="backpressure_boundary">backpressure_boundary</a></li><li><a href="#method.codec" title="codec">codec</a></li><li><a href="#method.codec_mut" title="codec_mut">codec_mut</a></li><li><a href="#method.codec_pin_mut" title="codec_pin_mut">codec_pin_mut</a></li><li><a href="#method.from_parts" title="from_parts">from_parts</a></li><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.get_pin_mut" title="get_pin_mut">get_pin_mut</a></li><li><a href="#method.get_ref" title="get_ref">get_ref</a></li><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.into_parts" title="into_parts">into_parts</a></li><li><a href="#method.map_codec" title="map_codec">map_codec</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.read_buffer" title="read_buffer">read_buffer</a></li><li><a href="#method.read_buffer_mut" title="read_buffer_mut">read_buffer_mut</a></li><li><a href="#method.set_backpressure_boundary" title="set_backpressure_boundary">set_backpressure_boundary</a></li><li><a href="#method.with_capacity" title="with_capacity">with_capacity</a></li><li><a href="#method.write_buffer" title="write_buffer">write_buffer</a></li><li><a href="#method.write_buffer_mut" title="write_buffer_mut">write_buffer_mut</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Framed%3CT,+U%3E" title="Debug">Debug</a></li><li><a href="#impl-Sink%3CI%3E-for-Framed%3CT,+U%3E" title="Sink<I>">Sink<I></a></li><li><a href="#impl-Stream-for-Framed%3CT,+U%3E" title="Stream">Stream</a></li><li><a href="#impl-Unpin-for-Framed%3CT,+U%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Framed%3CT,+U%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Framed%3CT,+U%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Framed%3CT,+U%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Framed%3CT,+U%3E" title="Sync">Sync</a></li><li><a href="#impl-UnwindSafe-for-Framed%3CT,+U%3E" 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-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><li><a href="#impl-TryStream-for-S" title="TryStream">TryStream</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio_<wbr>util::<wbr>codec</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_util</a>::<wbr><a href="index.html">codec</a></div><h1>Struct <span class="struct">Framed</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_util/codec/framed.rs.html#16-42">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Framed<T, U> { <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>A unified <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a> interface to an underlying I/O object, using
|
|
the <code>Encoder</code> and <code>Decoder</code> traits to encode and decode frames.</p>
|
|
<p>You can create a <code>Framed</code> instance by using the <a href="trait.Decoder.html#method.framed" title="method tokio_util::codec::Decoder::framed"><code>Decoder::framed</code></a> adapter, or
|
|
by using the <code>new</code> function seen below.</p>
|
|
<h2 id="cancellation-safety"><a class="doc-anchor" href="#cancellation-safety">§</a>Cancellation safety</h2>
|
|
<ul>
|
|
<li><a href="futures_util::sink::SinkExt::send"><code>futures_util::sink::SinkExt::send</code></a>: if send is used as the event in a
|
|
<code>tokio::select!</code> statement and some other branch completes first, then it is
|
|
guaranteed that the message was not sent, but the message itself is lost.</li>
|
|
<li><a href="https://docs.rs/tokio-stream/latest/tokio_stream/trait.StreamExt.html#method.next"><code>tokio_stream::StreamExt::next</code></a>: This method is cancel safe. The returned
|
|
future only holds onto a reference to the underlying stream, so dropping it will
|
|
never lose a value.</li>
|
|
</ul>
|
|
</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-Framed%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#44-299">Source</a><a href="#impl-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#73-81">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(inner: T, codec: U) -> <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U></h4></section></summary><div class="docblock"><p>Provides a <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a> interface for reading and writing to this
|
|
I/O object, using <a href="trait.Decoder.html" title="trait tokio_util::codec::Decoder"><code>Decoder</code></a> and <a href="trait.Encoder.html" title="trait tokio_util::codec::Encoder"><code>Encoder</code></a> to read and write the raw data.</p>
|
|
<p>Raw I/O objects work with byte sequences, but higher-level code usually
|
|
wants to batch these into meaningful chunks, called “frames”. This
|
|
method layers framing on top of an I/O object, by using the codec
|
|
traits to handle encoding and decoding of messages frames. Note that
|
|
the incoming and outgoing frame types may be distinct.</p>
|
|
<p>This function returns a <em>single</em> object that is both <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and
|
|
<a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a>; grouping this into a single object is often useful for layering
|
|
things like gzip or TLS, which require both read and write access to the
|
|
underlying object.</p>
|
|
<p>If you want to work more directly with the streams and sink, consider
|
|
calling <a href="https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split"><code>split</code></a> on the <code>Framed</code> returned by this method, which will
|
|
break them into separate objects, allowing them to interact more easily.</p>
|
|
<p>Note that, for some byte sources, the stream can be resumed after an EOF
|
|
by reading from it, even after it has returned <code>None</code>. Repeated attempts
|
|
to do so, without new data available, continue to return <code>None</code> without
|
|
creating more (closing) frames.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#107-126">Source</a><h4 class="code-header">pub fn <a href="#method.with_capacity" class="fn">with_capacity</a>(inner: T, codec: U, capacity: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U></h4></section></summary><div class="docblock"><p>Provides a <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a> interface for reading and writing to this
|
|
I/O object, using <a href="trait.Decoder.html" title="trait tokio_util::codec::Decoder"><code>Decoder</code></a> and <a href="trait.Encoder.html" title="trait tokio_util::codec::Encoder"><code>Encoder</code></a> to read and write the raw data,
|
|
with a specific read buffer initial capacity.</p>
|
|
<p>Raw I/O objects work with byte sequences, but higher-level code usually
|
|
wants to batch these into meaningful chunks, called “frames”. This
|
|
method layers framing on top of an I/O object, by using the codec
|
|
traits to handle encoding and decoding of messages frames. Note that
|
|
the incoming and outgoing frame types may be distinct.</p>
|
|
<p>This function returns a <em>single</em> object that is both <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and
|
|
<a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a>; grouping this into a single object is often useful for layering
|
|
things like gzip or TLS, which require both read and write access to the
|
|
underlying object.</p>
|
|
<p>If you want to work more directly with the streams and sink, consider
|
|
calling <a href="https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split"><code>split</code></a> on the <code>Framed</code> returned by this method, which will
|
|
break them into separate objects, allowing them to interact more easily.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_parts" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#155-166">Source</a><h4 class="code-header">pub fn <a href="#method.from_parts" class="fn">from_parts</a>(parts: <a class="struct" href="struct.FramedParts.html" title="struct tokio_util::codec::FramedParts">FramedParts</a><T, U>) -> <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U></h4></section></summary><div class="docblock"><p>Provides a <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and <a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a> interface for reading and writing to this
|
|
I/O object, using <a href="trait.Decoder.html" title="trait tokio_util::codec::Decoder"><code>Decoder</code></a> and <a href="trait.Encoder.html" title="trait tokio_util::codec::Encoder"><code>Encoder</code></a> to read and write the raw data.</p>
|
|
<p>Raw I/O objects work with byte sequences, but higher-level code usually
|
|
wants to batch these into meaningful chunks, called “frames”. This
|
|
method layers framing on top of an I/O object, by using the <code>Codec</code>
|
|
traits to handle encoding and decoding of messages frames. Note that
|
|
the incoming and outgoing frame types may be distinct.</p>
|
|
<p>This function returns a <em>single</em> object that is both <a href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream"><code>Stream</code></a> and
|
|
<a href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink"><code>Sink</code></a>; grouping this into a single object is often useful for layering
|
|
things like gzip or TLS, which require both read and write access to the
|
|
underlying object.</p>
|
|
<p>This objects takes a stream and a <code>readbuffer</code> and a <code>writebuffer</code>. These field
|
|
can be obtained from an existing <code>Framed</code> with the <a href="struct.Framed.html#method.into_parts" title="method tokio_util::codec::Framed::into_parts"><code>into_parts</code></a> method.</p>
|
|
<p>If you want to work more directly with the streams and sink, consider
|
|
calling <a href="https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split"><code>split</code></a> on the <code>Framed</code> returned by this method, which will
|
|
break them into separate objects, allowing them to interact more easily.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_ref" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#174-176">Source</a><h4 class="code-header">pub fn <a href="#method.get_ref" class="fn">get_ref</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"><p>Returns a reference to the underlying I/O stream wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying stream
|
|
of data coming in as it may corrupt the stream of frames otherwise
|
|
being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#184-186">Source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_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"><p>Returns a mutable reference to the underlying I/O stream wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying stream
|
|
of data coming in as it may corrupt the stream of frames otherwise
|
|
being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_pin_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#194-196">Source</a><h4 class="code-header">pub fn <a href="#method.get_pin_mut" class="fn">get_pin_mut</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>) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<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"><p>Returns a pinned mutable reference to the underlying I/O stream wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying stream
|
|
of data coming in as it may corrupt the stream of frames otherwise
|
|
being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.codec" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#203-205">Source</a><h4 class="code-header">pub fn <a href="#method.codec" class="fn">codec</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&U</a></h4></section></summary><div class="docblock"><p>Returns a reference to the underlying codec wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying codec
|
|
as it may corrupt the stream of frames otherwise being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.codec_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#212-214">Source</a><h4 class="code-header">pub fn <a href="#method.codec_mut" class="fn">codec_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut U</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the underlying codec wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying codec
|
|
as it may corrupt the stream of frames otherwise being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.map_codec" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#221-234">Source</a><h4 class="code-header">pub fn <a href="#method.map_codec" class="fn">map_codec</a><C, F>(self, map: F) -> <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, C><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(U) -> C,</div></h4></section></summary><div class="docblock"><p>Maps the codec <code>U</code> to <code>C</code>, preserving the read and write buffers
|
|
wrapped by <code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying codec
|
|
as it may corrupt the stream of frames otherwise being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.codec_pin_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#241-243">Source</a><h4 class="code-header">pub fn <a href="#method.codec_pin_mut" class="fn">codec_pin_mut</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>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut U</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the underlying codec wrapped by
|
|
<code>Framed</code>.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying codec
|
|
as it may corrupt the stream of frames otherwise being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.read_buffer" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#246-248">Source</a><h4 class="code-header">pub fn <a href="#method.read_buffer" class="fn">read_buffer</a>(&self) -> &<a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a></h4></section></summary><div class="docblock"><p>Returns a reference to the read buffer.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.read_buffer_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#251-253">Source</a><h4 class="code-header">pub fn <a href="#method.read_buffer_mut" class="fn">read_buffer_mut</a>(&mut self) -> &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the read buffer.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_buffer" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#256-258">Source</a><h4 class="code-header">pub fn <a href="#method.write_buffer" class="fn">write_buffer</a>(&self) -> &<a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a></h4></section></summary><div class="docblock"><p>Returns a reference to the write buffer.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_buffer_mut" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#261-263">Source</a><h4 class="code-header">pub fn <a href="#method.write_buffer_mut" class="fn">write_buffer_mut</a>(&mut self) -> &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the write buffer.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.backpressure_boundary" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#266-268">Source</a><h4 class="code-header">pub fn <a href="#method.backpressure_boundary" class="fn">backpressure_boundary</a>(&self) -> <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>Returns backpressure boundary</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_backpressure_boundary" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#271-273">Source</a><h4 class="code-header">pub fn <a href="#method.set_backpressure_boundary" class="fn">set_backpressure_boundary</a>(&mut self, boundary: <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>Updates backpressure boundary</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#280-282">Source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> T</h4></section></summary><div class="docblock"><p>Consumes the <code>Framed</code>, returning its underlying I/O stream.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying stream
|
|
of data coming in as it may corrupt the stream of frames otherwise
|
|
being worked with.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_parts" class="method"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#290-298">Source</a><h4 class="code-header">pub fn <a href="#method.into_parts" class="fn">into_parts</a>(self) -> <a class="struct" href="struct.FramedParts.html" title="struct tokio_util::codec::FramedParts">FramedParts</a><T, U></h4></section></summary><div class="docblock"><p>Consumes the <code>Framed</code>, returning its underlying I/O stream, the buffer
|
|
with unprocessed data, and the codec.</p>
|
|
<p>Note that care should be taken to not tamper with the underlying stream
|
|
of data coming in as it may corrupt the stream of frames otherwise
|
|
being worked with.</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-Debug-for-Framed%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#340-351">Source</a><a href="#impl-Debug-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></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_util/codec/framed.rs.html#345-350">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><details class="toggle implementors-toggle" open><summary><section id="impl-Sink%3CI%3E-for-Framed%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#315-338">Source</a><a href="#impl-Sink%3CI%3E-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, I, U> <a class="trait" href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink">Sink</a><I> for <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a>,
|
|
U: <a class="trait" href="trait.Encoder.html" title="trait tokio_util::codec::Encoder">Encoder</a><I>,
|
|
U::<a class="associatedtype" href="trait.Encoder.html#associatedtype.Error" title="type tokio_util::codec::Encoder::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.93.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>,</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="../../src/tokio_util/codec/framed.rs.html#321">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="../../futures_sink/trait.Sink.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="trait.Encoder.html" title="trait tokio_util::codec::Encoder">Encoder</a><I>>::<a class="associatedtype" href="trait.Encoder.html#associatedtype.Error" title="type tokio_util::codec::Encoder::Error">Error</a></h4></section></summary><div class='docblock'>The type of value produced by the sink when an error occurs.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_ready" class="method trait-impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#323-325">Source</a><a href="#method.poll_ready" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_ready" class="fn">poll_ready</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><'_>,
|
|
) -> <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="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></h4></section></summary><div class='docblock'>Attempts to prepare the <code>Sink</code> to receive a value. <a href="../../futures_sink/trait.Sink.html#tymethod.poll_ready">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.start_send" class="method trait-impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#327-329">Source</a><a href="#method.start_send" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_sink/trait.Sink.html#tymethod.start_send" class="fn">start_send</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>, item: I) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>></h4></section></summary><div class='docblock'>Begin the process of sending a value to the sink.
|
|
Each call to this function must be preceded by a successful call to
|
|
<code>poll_ready</code> which returned <code>Poll::Ready(Ok(()))</code>. <a href="../../futures_sink/trait.Sink.html#tymethod.start_send">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_util/codec/framed.rs.html#331-333">Source</a><a href="#method.poll_flush" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_sink/trait.Sink.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>,
|
|
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="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></h4></section></summary><div class='docblock'>Flush any remaining output from this sink. <a href="../../futures_sink/trait.Sink.html#tymethod.poll_flush">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_close" class="method trait-impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#335-337">Source</a><a href="#method.poll_close" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_close" class="fn">poll_close</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><'_>,
|
|
) -> <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="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></h4></section></summary><div class='docblock'>Flush any remaining output and close this sink, if necessary. <a href="../../futures_sink/trait.Sink.html#tymethod.poll_close">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Stream-for-Framed%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#302-312">Source</a><a href="#impl-Stream-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a> for <a class="struct" href="struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a>,
|
|
U: <a class="trait" href="trait.Decoder.html" title="trait tokio_util::codec::Decoder">Decoder</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#307">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="../../futures_core/stream/trait.Stream.html#associatedtype.Item" class="associatedtype">Item</a> = <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 as <a class="trait" href="trait.Decoder.html" title="trait tokio_util::codec::Decoder">Decoder</a>>::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Item" title="type tokio_util::codec::Decoder::Item">Item</a>, <U as <a class="trait" href="trait.Decoder.html" title="trait tokio_util::codec::Decoder">Decoder</a>>::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Error" title="type tokio_util::codec::Decoder::Error">Error</a>></h4></section></summary><div class='docblock'>Values yielded by the stream.</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_next" class="method trait-impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#309-311">Source</a><a href="#method.poll_next" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_core/stream/trait.Stream.html#tymethod.poll_next" class="fn">poll_next</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><'_>,
|
|
) -> <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="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="../../futures_core/stream/trait.Stream.html#associatedtype.Item" title="type futures_core::stream::Stream::Item">Item</a>>></h4></section></summary><div class='docblock'>Attempt to pull out the next value of this stream, registering the
|
|
current task for wakeup if the value is not yet available, and returning
|
|
<code>None</code> if the stream is exhausted. <a href="../../futures_core/stream/trait.Stream.html#tymethod.poll_next">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.size_hint" class="method trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#105">Source</a><a href="#method.size_hint" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_core/stream/trait.Stream.html#method.size_hint" class="fn">size_hint</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</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'>Returns the bounds on the remaining length of the stream. <a href="../../futures_core/stream/trait.Stream.html#method.size_hint">Read more</a></div></details></div></details><section id="impl-Unpin-for-Framed%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/tokio_util/codec/framed.rs.html#16-42">Source</a><a href="#impl-Unpin-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<'__pin, T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
PinnedFieldsOf<__Origin<'__pin, T, U>>: <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></h3></section></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-Framed%3CT,+U%3E" class="impl"><a href="#impl-Freeze-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-Framed%3CT,+U%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <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>,
|
|
U: <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>,</div></h3></section><section id="impl-Send-for-Framed%3CT,+U%3E" class="impl"><a href="#impl-Send-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-Framed%3CT,+U%3E" class="impl"><a href="#impl-Sync-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-UnwindSafe-for-Framed%3CT,+U%3E" class="impl"><a href="#impl-UnwindSafe-for-Framed%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> <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.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, U><div class="where">where
|
|
T: <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>,
|
|
U: <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>,</div></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-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-2" 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-2" 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-1" 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-1" 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><details class="toggle implementors-toggle"><summary><section id="impl-TryStream-for-S" class="impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#195-197">Source</a><a href="#impl-TryStream-for-S" class="anchor">§</a><h3 class="code-header">impl<S, T, E> <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a> for S<div class="where">where
|
|
S: <a class="trait" href="../../futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a><Item = <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, E>> + ?<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" open><summary><section id="associatedtype.Ok" class="associatedtype trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#199">Source</a><a href="#associatedtype.Ok" class="anchor">§</a><h4 class="code-header">type <a href="../../futures_core/stream/trait.TryStream.html#associatedtype.Ok" class="associatedtype">Ok</a> = T</h4></section></summary><div class='docblock'>The type of successful values yielded by this future</div></details><details class="toggle" open><summary><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#200">Source</a><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="../../futures_core/stream/trait.TryStream.html#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section></summary><div class='docblock'>The type of failures yielded by this future</div></details><details class="toggle method-toggle" open><summary><section id="method.try_poll_next" class="method trait-impl"><a class="src rightside" href="../../src/futures_core/stream.rs.html#202-205">Source</a><a href="#method.try_poll_next" class="anchor">§</a><h4 class="code-header">fn <a href="../../futures_core/stream/trait.TryStream.html#tymethod.try_poll_next" class="fn">try_poll_next</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><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut S</a>>,
|
|
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="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<S as <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="../../futures_core/stream/trait.TryStream.html#associatedtype.Ok" title="type futures_core::stream::TryStream::Ok">Ok</a>, <S as <a class="trait" href="../../futures_core/stream/trait.TryStream.html" title="trait futures_core::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="../../futures_core/stream/trait.TryStream.html#associatedtype.Error" title="type futures_core::stream::TryStream::Error">Error</a>>>></h4></section></summary><div class='docblock'>Poll this <code>TryStream</code> as if it were a <code>Stream</code>. <a href="../../futures_core/stream/trait.TryStream.html#tymethod.try_poll_next">Read more</a></div></details></div></details></div></section></div></main></body></html> |