1
0
mirror of https://github.com/fafhrd91/actix-net synced 2025-01-18 18:51:49 +01:00
actix-net/actix_codec/trait.Decoder.html
2024-10-01 00:01:00 +00:00

130 lines
24 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Decoding of frames via buffers."><title>Decoder in actix_codec - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b778ab399e080a4b.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_codec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc trait"><!--[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" title="show sidebar"></button><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_codec/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_codec/index.html">actix_<wbr>codec</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Decoder</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li><li><a href="#associatedtype.Item" title="Item">Item</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.decode" title="decode">decode</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.decode_eof" title="decode_eof">decode_eof</a></li><li><a href="#method.framed" title="framed">framed</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate actix_<wbr>codec</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">actix_codec</a></span><h1>Trait <span class="trait">Decoder</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait Decoder {
type <a href="#associatedtype.Item" class="associatedtype">Item</a>;
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;;
// Required method
fn <a href="#tymethod.decode" class="fn">decode</a>(
&amp;mut self,
src: &amp;mut BytesMut,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Item" title="type actix_codec::Decoder::Item">Item</a>&gt;, Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Error" title="type actix_codec::Decoder::Error">Error</a>&gt;;
// Provided methods
fn <a href="#method.decode_eof" class="fn">decode_eof</a>(
&amp;mut self,
buf: &amp;mut BytesMut,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Item" title="type actix_codec::Decoder::Item">Item</a>&gt;, Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Error" title="type actix_codec::Decoder::Error">Error</a>&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.framed" class="fn">framed</a>&lt;T&gt;(self, io: T) -&gt; Framed&lt;T, Self&gt;
<span class="where">where T: <a class="trait" href="trait.AsyncRead.html" title="trait actix_codec::AsyncRead">AsyncRead</a> + <a class="trait" href="trait.AsyncWrite.html" title="trait actix_codec::AsyncWrite">AsyncWrite</a>,
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decoding of frames via buffers.</p>
<p>This trait is used when constructing an instance of <a href="crate::codec::Framed"><code>Framed</code></a> or
<a href="crate::codec::FramedRead"><code>FramedRead</code></a>. An implementation of <code>Decoder</code> takes a byte stream that has
already been buffered in <code>src</code> and decodes the data into a stream of
<code>Self::Item</code> frames.</p>
<p>Implementations are able to track state on <code>self</code>, which enables
implementing stateful streaming parsers. In many cases, though, this type
will simply be a unit struct (e.g. <code>struct HttpDecoder</code>).</p>
<p>For some underlying data-sources, namely files and FIFOs,
its possible to temporarily read 0 bytes by reaching EOF.</p>
<p>In these cases <code>decode_eof</code> will be called until it signals
fulfillment of all closing frames by returning <code>Ok(None)</code>.
After that, repeated attempts to read from the <a href="crate::codec::Framed"><code>Framed</code></a> or <a href="crate::codec::FramedRead"><code>FramedRead</code></a>
will not invoke <code>decode</code> or <code>decode_eof</code> again, until data can be read
during a retry.</p>
<p>It is up to the Decoder to keep track of a restart after an EOF,
and to decide how to handle such an event by, for example,
allowing frames to cross EOF boundaries, re-emitting opening frames, or
resetting the entire internal state.</p>
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Item" class="method"><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a></h4></section></summary><div class="docblock"><p>The type of decoded frames.</p>
</div></details><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>The type of unrecoverable frame decoding errors.</p>
<p>If an individual message is ill-formed but can be ignored without
interfering with the processing of future messages, it may be more
useful to report the failure as an <code>Item</code>.</p>
<p><code>From&lt;io::Error&gt;</code> is required in the interest of making <code>Error</code> suitable
for returning directly from a <a href="crate::codec::FramedRead"><code>FramedRead</code></a>, and to enable the default
implementation of <code>decode_eof</code> to yield an <code>io::Error</code> when the decoder
fails to consume all available data.</p>
<p>Note that implementors of this trait can simply indicate <code>type Error = io::Error</code> to use I/O errors as this type.</p>
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.decode" class="method"><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(
&amp;mut self,
src: &amp;mut BytesMut,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Item" title="type actix_codec::Decoder::Item">Item</a>&gt;, Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Error" title="type actix_codec::Decoder::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Attempts to decode a frame from the provided buffer of bytes.</p>
<p>This method is called by <a href="crate::codec::FramedRead"><code>FramedRead</code></a> whenever bytes are ready to be
parsed. The provided buffer of bytes is whats been read so far, and
this instance of <code>Decode</code> can determine whether an entire frame is in
the buffer and is ready to be returned.</p>
<p>If an entire frame is available, then this instance will remove those
bytes from the buffer provided and return them as a decoded
frame. Note that removing bytes from the provided buffer doesnt always
necessarily copy the bytes, so this should be an efficient operation in
most circumstances.</p>
<p>If the bytes look valid, but a frame isnt fully available yet, then
<code>Ok(None)</code> is returned. This indicates to the <a href="crate::codec::Framed"><code>Framed</code></a> instance that
it needs to read some more bytes before calling this method again.</p>
<p>Note that the bytes provided may be empty. If a previous call to
<code>decode</code> consumed all the bytes in the buffer then <code>decode</code> will be
called again until it returns <code>Ok(None)</code>, indicating that more bytes need to
be read.</p>
<p>Finally, if the bytes in the buffer are malformed then an error is
returned indicating why. This informs <a href="crate::codec::Framed"><code>Framed</code></a> that the stream is now
corrupt and should be terminated.</p>
<h5 id="buffer-management"><a class="doc-anchor" href="#buffer-management">§</a>Buffer management</h5>
<p>Before returning from the function, implementations should ensure that
the buffer has appropriate capacity in anticipation of future calls to
<code>decode</code>. Failing to do so leads to inefficiency.</p>
<p>For example, if frames have a fixed length, or if the length of the
current frame is known from a header, a possible buffer management
strategy is:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Decoder <span class="kw">for </span>MyCodec {
<span class="comment">// ...
</span><span class="kw">fn </span>decode(<span class="kw-2">&amp;mut </span><span class="self">self</span>, src: <span class="kw-2">&amp;mut </span>BytesMut) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;, <span class="self">Self</span>::Error&gt; {
<span class="comment">// ...
// Reserve enough to complete decoding of the current frame.
</span><span class="kw">let </span>current_frame_len: usize = <span class="number">1000</span>; <span class="comment">// Example.
// And to start decoding the next frame.
</span><span class="kw">let </span>next_frame_header_len: usize = <span class="number">10</span>; <span class="comment">// Example.
</span>src.reserve(current_frame_len + next_frame_header_len);
<span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>);
}
}</code></pre></div>
<p>An optimal buffer management strategy minimizes reallocations and
over-allocations.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.decode_eof" class="method"><h4 class="code-header">fn <a href="#method.decode_eof" class="fn">decode_eof</a>(
&amp;mut self,
buf: &amp;mut BytesMut,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Item" title="type actix_codec::Decoder::Item">Item</a>&gt;, Self::<a class="associatedtype" href="trait.Decoder.html#associatedtype.Error" title="type actix_codec::Decoder::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>A default method available to be called when there are no more bytes
available to be read from the underlying I/O.</p>
<p>This method defaults to calling <code>decode</code> and returns an error if
<code>Ok(None)</code> is returned while there is unconsumed data in <code>buf</code>.
Typically this doesnt need to be implemented unless the framing
protocol differs near the end of the stream, or if you need to construct
frames <em>across</em> eof boundaries on sources that can be resumed.</p>
<p>Note that the <code>buf</code> argument may be empty. If a previous call to
<code>decode_eof</code> consumed all the bytes in the buffer, <code>decode_eof</code> will be
called again until it returns <code>None</code>, indicating that there are no more
frames to yield. This behavior enables returning finalization frames
that may not be based on inbound data.</p>
<p>Once <code>None</code> has been returned, <code>decode_eof</code> wont be called again until
an attempt to resume the stream has been made, where the underlying stream
actually returned more data.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.framed" class="method"><h4 class="code-header">fn <a href="#method.framed" class="fn">framed</a>&lt;T&gt;(self, io: T) -&gt; Framed&lt;T, Self&gt;<div class="where">where
T: <a class="trait" href="trait.AsyncRead.html" title="trait actix_codec::AsyncRead">AsyncRead</a> + <a class="trait" href="trait.AsyncWrite.html" title="trait actix_codec::AsyncWrite">AsyncWrite</a>,
Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Provides a <a href="futures_core::Stream"><code>Stream</code></a> and <a href="futures_sink::Sink"><code>Sink</code></a> interface for reading and writing to this
<code>Io</code> object, using <code>Decode</code> and <code>Encode</code> 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 <code>Stream</code> and
<code>Sink</code>; 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 <code>split</code> on the <a href="crate::codec::Framed"><code>Framed</code></a> returned by this method, which will
break them into separate objects, allowing them to interact more easily.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-BytesCodec" class="impl"><a class="src rightside" href="../src/actix_codec/bcodec.rs.html#21-32">source</a><a href="#impl-Decoder-for-BytesCodec" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for actix_codec::<a class="struct" href="struct.BytesCodec.html" title="struct actix_codec::BytesCodec">BytesCodec</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/actix_codec/bcodec.rs.html#22">source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = BytesMut</h4></section><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/actix_codec/bcodec.rs.html#23">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-LinesCodec" class="impl"><a class="src rightside" href="../src/actix_codec/lines.rs.html#29-86">source</a><a href="#impl-Decoder-for-LinesCodec" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for actix_codec::<a class="struct" href="struct.LinesCodec.html" title="struct actix_codec::LinesCodec">LinesCodec</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/actix_codec/lines.rs.html#30">source</a><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/actix_codec/lines.rs.html#31">source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-AnyDelimiterCodec" class="impl"><a href="#impl-Decoder-for-AnyDelimiterCodec" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for AnyDelimiterCodec</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-3" class="associatedtype trait-impl"><a href="#associatedtype.Item-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = Bytes</h4></section><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = AnyDelimiterCodecError</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-BytesCodec-1" class="impl"><a href="#impl-Decoder-for-BytesCodec-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for BytesCodec</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-4" class="associatedtype trait-impl"><a href="#associatedtype.Item-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = BytesMut</h4></section><section id="associatedtype.Error-4" class="associatedtype trait-impl"><a href="#associatedtype.Error-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-LengthDelimitedCodec" class="impl"><a href="#impl-Decoder-for-LengthDelimitedCodec" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for LengthDelimitedCodec</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-5" class="associatedtype trait-impl"><a href="#associatedtype.Item-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = BytesMut</h4></section><section id="associatedtype.Error-5" class="associatedtype trait-impl"><a href="#associatedtype.Error-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Decoder-for-LinesCodec-1" class="impl"><a href="#impl-Decoder-for-LinesCodec-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Decoder.html" title="trait actix_codec::Decoder">Decoder</a> for LinesCodec</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-6" class="associatedtype trait-impl"><a href="#associatedtype.Item-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section><section id="associatedtype.Error-6" class="associatedtype trait-impl"><a href="#associatedtype.Error-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = LinesCodecError</h4></section></div></details></div><script src="../trait.impl/tokio_util/codec/decoder/trait.Decoder.js" data-ignore-extern-crates="tokio_util" async></script></section></div></main></body></html>