19 lines
14 KiB
HTML
19 lines
14 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 `actix_codec`."><meta name="keywords" content="rust, rustlang, rust-lang, Encoder"><title>actix_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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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='../actix_codec/index.html'><div class='logo-container'><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.Item">Item</a><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="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Encoder-for-BytesCodec">BytesCodec</a><a href="#impl-Encoder-for-LinesCodec">LinesCodec</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>actix_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!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/tokio_io/codec/encoder.rs.html#9-25' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>actix_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 {
|
||
type <a href='#associatedtype.Item' class="type">Item</a>;
|
||
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: Self::<a class="type" href="../actix_codec/trait.Encoder.html#associatedtype.Item" title="type actix_codec::Encoder::Item">Item</a>, <br> dst: &mut <a class="struct" href="../bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::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="../actix_codec/trait.Encoder.html#associatedtype.Error" title="type actix_codec::Encoder::Error">Error</a>>;
|
||
}</pre></div><div class='docblock'><p>Trait of helper objects to write out messages as bytes, for use with
|
||
<code>FramedWrite</code>.</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.Item' class='method'><code id='Item.t'>type <a href='#associatedtype.Item' class="type">Item</a></code></h3><div class='docblock'><p>The type of items consumed by the <code>Encoder</code></p>
|
||
</div><h3 id='associatedtype.Error' class='method'><code id='Error.t'>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></h3><div class='docblock'><p>The type of encoding errors.</p>
|
||
<p><code>FramedWrite</code> 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 id='encode.v'>fn <a href='#tymethod.encode' class='fnname'>encode</a>(<br> &mut self, <br> item: Self::<a class="type" href="../actix_codec/trait.Encoder.html#associatedtype.Item" title="type actix_codec::Encoder::Item">Item</a>, <br> dst: &mut <a class="struct" href="../bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::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="../actix_codec/trait.Encoder.html#associatedtype.Error" title="type actix_codec::Encoder::Error">Error</a>></code></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 <code>Framed</code> instance and
|
||
will be written out when possible.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Encoder-for-LinesCodec' class='impl'><code class='in-band'>impl <a class="trait" href="../actix_codec/trait.Encoder.html" title="trait actix_codec::Encoder">Encoder</a> for <a class="struct" href="../tokio_codec/lines_codec/struct.LinesCodec.html" title="struct tokio_codec::lines_codec::LinesCodec">LinesCodec</a></code><a href='#impl-Encoder-for-LinesCodec' class='anchor'></a><a class='srclink' href='../src/tokio_codec/lines_codec.rs.html#185-195' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><code id='Item.t-1'>type <a href='#associatedtype.Item' class="type">Item</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></h4><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='#associatedtype.Error' 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 id='encode.v-1'>fn <a href='#method.encode' class='fnname'>encode</a>(&mut self, line: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, buf: &mut <a class="struct" href="../bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::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_codec/lines_codec.rs.html#189-194' title='goto source code'>[src]</a></h4></div><h3 id='impl-Encoder-for-BytesCodec' class='impl'><code class='in-band'>impl <a class="trait" href="../actix_codec/trait.Encoder.html" title="trait actix_codec::Encoder">Encoder</a> for <a class="struct" href="../tokio_codec/bytes_codec/struct.BytesCodec.html" title="struct tokio_codec::bytes_codec::BytesCodec">BytesCodec</a></code><a href='#impl-Encoder-for-BytesCodec' class='anchor'></a><a class='srclink' href='../src/tokio_codec/bytes_codec.rs.html#30-39' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><code id='Item.t-2'>type <a href='#associatedtype.Item' class="type">Item</a> = <a class="struct" href="../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a></code></h4><h4 id='associatedtype.Error-2' class="type"><code id='Error.t-2'>type <a href='#associatedtype.Error' 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 id='encode.v-2'>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>, buf: &mut <a class="struct" href="../bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::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_codec/bytes_codec.rs.html#34-38' title='goto source code'>[src]</a></h4></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' class='impl'><code class='in-band'>impl Encoder for actix_codec::<a class="struct" href="../actix_codec/struct.BytesCodec.html" title="struct actix_codec::BytesCodec">BytesCodec</a></code><a href='#impl-Encoder' class='anchor'></a><a class='srclink' href='../src/actix_codec/bcodec.rs.html#12-20' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-3' class="type"><code id='Item.t-3'>type <a href='#associatedtype.Item-3' class="type">Item</a> = <a class="struct" href="../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a></code></h4><h4 id='associatedtype.Error-3' class="type"><code id='Error.t-3'>type <a href='#associatedtype.Error-3' 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-2' class="method hidden"><code id='encode.v-3'>fn <a href='#method.encode-2' class='fnname'>encode</a>(&mut self, item: <a class="struct" href="../bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, dst: &mut <a class="struct" href="../bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::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="../actix_codec/trait.Encoder.html#associatedtype.Error" title="type actix_codec::Encoder::Error">Error</a>></code><a class='srclink' href='../src/actix_codec/bcodec.rs.html#16-19' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/tokio_io/codec/encoder/trait.Encoder.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "actix_codec";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |