github-actions[bot]
16 lines
15 KiB
HTML
16 lines
15 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Encoder` trait in crate `tokio_util`."><meta name="keywords" content="rust, rustlang, rust-lang, Encoder"><title>tokio_util::codec::Encoder - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tokio_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait Encoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.encode">encode</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">tokio_util</a>::<wbr><a href="index.html">codec</a></p><script>window.sidebarCurrent = {name: "Encoder", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tokio_util/codec/encoder.rs.html#8-25" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">tokio_util</a>::<wbr><a href="index.html">codec</a>::<wbr><a class="trait" href="">Encoder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait Encoder<Item> {
|
||
type <a href="#associatedtype.Error" class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>;
|
||
fn <a href="#tymethod.encode" class="fnname">encode</a>(<br> &mut self, <br> item: Item, <br> dst: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_util/codec/trait.Encoder.html#associatedtype.Error" title="type tokio_util::codec::Encoder::Error">Error</a>>;
|
||
}</pre></div><div class="docblock"><p>Trait of helper objects to write out messages as bytes, for use with
|
||
<a href="../../tokio_util/codec/struct.FramedWrite.html"><code>FramedWrite</code></a>.</p>
|
||
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Error" class="method"><code>type <a href="#associatedtype.Error" class="type">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/codec/encoder.rs.html#15" title="goto source code">[src]</a></h3><div class="docblock"><p>The type of encoding errors.</p>
|
||
<p><a href="../../tokio_util/codec/struct.FramedWrite.html"><code>FramedWrite</code></a> requires <code>Encoder</code>s errors to implement <code>From<io::Error></code>
|
||
in the interest letting it return <code>Error</code>s directly.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.encode" class="method"><code>fn <a href="#tymethod.encode" class="fnname">encode</a>(&mut self, item: Item, dst: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../tokio_util/codec/trait.Encoder.html#associatedtype.Error" title="type tokio_util::codec::Encoder::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/codec/encoder.rs.html#24" title="goto source code">[src]</a></h3><div class="docblock"><p>Encodes a frame into the buffer provided.</p>
|
||
<p>This method will encode <code>item</code> into the byte buffer provided by <code>dst</code>.
|
||
The <code>dst</code> provided is an internal buffer of the <a href="../../tokio_util/codec/struct.FramedWrite.html"><code>FramedWrite</code></a> instance and
|
||
will be written out when possible.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-Encoder%3CBytes%3E" class="impl"><code class="in-band">impl Encoder<<a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>> for <a class="struct" href="../../tokio_util/codec/length_delimited/struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a></code><a href="#impl-Encoder%3CBytes%3E" class="anchor"></a><a class="srclink" href="../../src/tokio_util/codec/length_delimited.rs.html#580-622" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="#associatedtype.Error-1" class="type">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></code></h4><h4 id="method.encode" class="method hidden"><code>fn <a href="#method.encode" class="fnname">encode</a>(&mut self, data: <a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, dst: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/codec/length_delimited.rs.html#583-621" title="goto source code">[src]</a></h4></div><h3 id="impl-Encoder%3CBytes%3E-1" class="impl"><code class="in-band">impl Encoder<<a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>> for <a class="struct" href="../../tokio_util/codec/struct.BytesCodec.html" title="struct tokio_util::codec::BytesCodec">BytesCodec</a></code><a href="#impl-Encoder%3CBytes%3E-1" class="anchor"></a><a class="srclink" href="../../src/tokio_util/codec/bytes_codec.rs.html#68-76" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-2" class="type"><code>type <a href="#associatedtype.Error-2" class="type">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></code></h4><h4 id="method.encode-1" class="method hidden"><code>fn <a href="#method.encode-1" class="fnname">encode</a>(&mut self, data: <a class="struct" href="../../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, buf: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/codec/bytes_codec.rs.html#71-75" title="goto source code">[src]</a></h4></div><h3 id="impl-Encoder%3CT%3E" class="impl"><code class="in-band">impl<T> Encoder<T> for <a class="struct" href="../../tokio_util/codec/struct.AnyDelimiterCodec.html" title="struct tokio_util::codec::AnyDelimiterCodec">AnyDelimiterCodec</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code><a href="#impl-Encoder%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/tokio_util/codec/any_delimiter_codec.rs.html#212-226" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-3" class="type"><code>type <a href="#associatedtype.Error-3" class="type">Error</a> = <a class="enum" href="../../tokio_util/codec/enum.AnyDelimiterCodecError.html" title="enum tokio_util::codec::AnyDelimiterCodecError">AnyDelimiterCodecError</a></code></h4><h4 id="method.encode-2" class="method hidden"><code>fn <a href="#method.encode-2" class="fnname">encode</a>(<br> &mut self, <br> chunk: T, <br> buf: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../tokio_util/codec/enum.AnyDelimiterCodecError.html" title="enum tokio_util::codec::AnyDelimiterCodecError">AnyDelimiterCodecError</a>></code><a class="srclink" href="../../src/tokio_util/codec/any_delimiter_codec.rs.html#218-225" title="goto source code">[src]</a></h4></div><h3 id="impl-Encoder%3CT%3E-1" class="impl"><code class="in-band">impl<T> Encoder<T> for <a class="struct" href="../../tokio_util/codec/struct.LinesCodec.html" title="struct tokio_util::codec::LinesCodec">LinesCodec</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code><a href="#impl-Encoder%3CT%3E-1" class="anchor"></a><a class="srclink" href="../../src/tokio_util/codec/lines_codec.rs.html#185-198" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-4" class="type"><code>type <a href="#associatedtype.Error-4" class="type">Error</a> = <a class="enum" href="../../tokio_util/codec/enum.LinesCodecError.html" title="enum tokio_util::codec::LinesCodecError">LinesCodecError</a></code></h4><h4 id="method.encode-3" class="method hidden"><code>fn <a href="#method.encode-3" class="fnname">encode</a>(&mut self, line: T, buf: &mut <a class="struct" href="../../bytes/bytes_mut/struct.BytesMut.html" title="struct bytes::bytes_mut::BytesMut">BytesMut</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../tokio_util/codec/enum.LinesCodecError.html" title="enum tokio_util::codec::LinesCodecError">LinesCodecError</a>></code><a class="srclink" href="../../src/tokio_util/codec/lines_codec.rs.html#191-197" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/tokio_util/codec/trait.Encoder.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tokio_util";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |