| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tonic-0.6.2/src/codec/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tonic/index.html"><div class="logo-container"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tonic/index.html"> |
| <img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Generic encoding and decoding. |
| //! |
| //! This module contains the generic `Codec`, `Encoder` and `Decoder` traits |
| //! and a protobuf codec based on prost. |
| |
| </span><span class="kw">mod </span>buffer; |
| <span class="attribute">#[cfg(feature = <span class="string">"compression"</span>)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>compression; |
| <span class="kw">mod </span>decode; |
| <span class="kw">mod </span>encode; |
| <span class="attribute">#[cfg(feature = <span class="string">"prost"</span>)] |
| </span><span class="kw">mod </span>prost; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::Status; |
| <span class="kw">use </span>std::io; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::encode::{encode_client, encode_server}; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::buffer::{DecodeBuf, EncodeBuf}; |
| <span class="attribute">#[cfg(feature = <span class="string">"compression"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"compression"</span>)))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::compression::{CompressionEncoding, EnabledCompressionEncodings}; |
| <span class="kw">pub use </span><span class="self">self</span>::decode::Streaming; |
| <span class="attribute">#[cfg(feature = <span class="string">"prost"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"prost"</span>)))] |
| </span><span class="kw">pub use </span><span class="self">self</span>::prost::ProstCodec; |
| |
| <span class="comment">// 5 bytes |
| </span><span class="kw">const </span>HEADER_SIZE: usize = |
| <span class="comment">// compression flag |
| </span>std::mem::size_of::<u8>() + |
| <span class="comment">// data length |
| </span>std::mem::size_of::<u32>(); |
| |
| <span class="doccomment">/// Trait that knows how to encode and decode gRPC messages. |
| </span><span class="kw">pub trait </span>Codec: Default { |
| <span class="doccomment">/// The encodable message. |
| </span><span class="kw">type </span>Encode: Send + <span class="lifetime">'static</span>; |
| <span class="doccomment">/// The decodable message. |
| </span><span class="kw">type </span>Decode: Send + <span class="lifetime">'static</span>; |
| |
| <span class="doccomment">/// The encoder that can encode a message. |
| </span><span class="kw">type </span>Encoder: Encoder<Item = <span class="self">Self</span>::Encode, Error = Status> + Send + <span class="lifetime">'static</span>; |
| <span class="doccomment">/// The encoder that can decode a message. |
| </span><span class="kw">type </span>Decoder: Decoder<Item = <span class="self">Self</span>::Decode, Error = Status> + Send + <span class="lifetime">'static</span>; |
| |
| <span class="doccomment">/// Fetch the encoder. |
| </span><span class="kw">fn </span>encoder(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="self">Self</span>::Encoder; |
| <span class="doccomment">/// Fetch the decoder. |
| </span><span class="kw">fn </span>decoder(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="self">Self</span>::Decoder; |
| } |
| |
| <span class="doccomment">/// Encodes gRPC message types |
| </span><span class="kw">pub trait </span>Encoder { |
| <span class="doccomment">/// The type that is encoded. |
| </span><span class="kw">type </span>Item; |
| |
| <span class="doccomment">/// The type of encoding errors. |
| /// |
| /// The type of unrecoverable frame encoding errors. |
| </span><span class="kw">type </span>Error: From<io::Error>; |
| |
| <span class="doccomment">/// Encodes a message into the provided buffer. |
| </span><span class="kw">fn </span>encode(<span class="kw-2">&mut </span><span class="self">self</span>, item: <span class="self">Self</span>::Item, dst: <span class="kw-2">&mut </span>EncodeBuf<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error>; |
| } |
| |
| <span class="doccomment">/// Decodes gRPC message types |
| </span><span class="kw">pub trait </span>Decoder { |
| <span class="doccomment">/// The type that is decoded. |
| </span><span class="kw">type </span>Item; |
| |
| <span class="doccomment">/// The type of unrecoverable frame decoding errors. |
| </span><span class="kw">type </span>Error: From<io::Error>; |
| |
| <span class="doccomment">/// Decode a message from the buffer. |
| /// |
| /// The buffer will contain exactly the bytes of a full message. There |
| /// is no need to get the length from the bytes, gRPC framing is handled |
| /// for you. |
| </span><span class="kw">fn </span>decode(<span class="kw-2">&mut </span><span class="self">self</span>, src: <span class="kw-2">&mut </span>DecodeBuf<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><<span class="self">Self</span>::Item>, <span class="self">Self</span>::Error>; |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
