| <!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/prost.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>prost.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> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| </pre><pre class="rust"><code><span class="kw">use super</span>::{Codec, DecodeBuf, Decoder, Encoder}; |
| <span class="kw">use </span><span class="kw">crate</span>::codec::EncodeBuf; |
| <span class="kw">use crate</span>::{Code, Status}; |
| <span class="kw">use </span>prost1::Message; |
| <span class="kw">use </span>std::marker::PhantomData; |
| |
| <span class="doccomment">/// A [`Codec`] that implements `application/grpc+proto` via the prost library.. |
| </span><span class="attribute">#[derive(Debug, Clone)] |
| </span><span class="kw">pub struct </span>ProstCodec<T, U> { |
| _pd: PhantomData<(T, U)>, |
| } |
| |
| <span class="kw">impl</span><T, U> Default <span class="kw">for </span>ProstCodec<T, U> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ _pd: PhantomData } |
| } |
| } |
| |
| <span class="kw">impl</span><T, U> Codec <span class="kw">for </span>ProstCodec<T, U> |
| <span class="kw">where |
| </span>T: Message + Send + <span class="lifetime">'static</span>, |
| U: Message + Default + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">type </span>Encode = T; |
| <span class="kw">type </span>Decode = U; |
| |
| <span class="kw">type </span>Encoder = ProstEncoder<T>; |
| <span class="kw">type </span>Decoder = ProstDecoder<U>; |
| |
| <span class="kw">fn </span>encoder(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="self">Self</span>::Encoder { |
| ProstEncoder(PhantomData) |
| } |
| |
| <span class="kw">fn </span>decoder(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="self">Self</span>::Decoder { |
| ProstDecoder(PhantomData) |
| } |
| } |
| |
| <span class="doccomment">/// A [`Encoder`] that knows how to encode `T`. |
| </span><span class="attribute">#[derive(Debug, Clone, Default)] |
| </span><span class="kw">pub struct </span>ProstEncoder<T>(PhantomData<T>); |
| |
| <span class="kw">impl</span><T: Message> Encoder <span class="kw">for </span>ProstEncoder<T> { |
| <span class="kw">type </span>Item = T; |
| <span class="kw">type </span>Error = Status; |
| |
| <span class="kw">fn </span>encode(<span class="kw-2">&mut </span><span class="self">self</span>, item: <span class="self">Self</span>::Item, buf: <span class="kw-2">&mut </span>EncodeBuf<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error> { |
| item.encode(buf) |
| .expect(<span class="string">"Message only errors if not enough space"</span>); |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// A [`Decoder`] that knows how to decode `U`. |
| </span><span class="attribute">#[derive(Debug, Clone, Default)] |
| </span><span class="kw">pub struct </span>ProstDecoder<U>(PhantomData<U>); |
| |
| <span class="kw">impl</span><U: Message + Default> Decoder <span class="kw">for </span>ProstDecoder<U> { |
| <span class="kw">type </span>Item = U; |
| <span class="kw">type </span>Error = Status; |
| |
| <span class="kw">fn </span>decode(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <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> { |
| <span class="kw">let </span>item = Message::decode(buf) |
| .map(Option::Some) |
| .map_err(from_decode_error)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(item) |
| } |
| } |
| |
| <span class="kw">fn </span>from_decode_error(error: prost1::DecodeError) -> <span class="kw">crate</span>::Status { |
| <span class="comment">// Map Protobuf parse errors to an INTERNAL status code, as per |
| // https://github.com/grpc/grpc/blob/master/doc/statuscodes.md |
| </span>Status::new(Code::Internal, error.to_string()) |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span><span class="kw">crate</span>::codec::compression::SingleMessageCompressionOverride; |
| <span class="kw">use </span><span class="kw">crate</span>::codec::{ |
| encode_server, DecodeBuf, Decoder, EncodeBuf, Encoder, Streaming, HEADER_SIZE, |
| }; |
| <span class="kw">use </span><span class="kw">crate</span>::Status; |
| <span class="kw">use </span>bytes::{Buf, BufMut, BytesMut}; |
| <span class="kw">use </span>http_body::Body; |
| |
| <span class="kw">const </span>LEN: usize = <span class="number">10000</span>; |
| |
| <span class="attribute">#[tokio::test] |
| </span><span class="kw">async fn </span>decode() { |
| <span class="kw">let </span>decoder = MockDecoder::default(); |
| |
| <span class="kw">let </span>msg = <span class="macro">vec!</span>[<span class="number">0u8</span>; LEN]; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::new(); |
| |
| buf.reserve(msg.len() + HEADER_SIZE); |
| buf.put_u8(<span class="number">0</span>); |
| buf.put_u32(msg.len() <span class="kw">as </span>u32); |
| |
| buf.put(<span class="kw-2">&</span>msg[..]); |
| |
| <span class="kw">let </span>body = body::MockBody::new(<span class="kw-2">&</span>buf[..], <span class="number">10005</span>, <span class="number">0</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>stream = Streaming::new_request(decoder, body, <span class="prelude-val">None</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0usize</span>; |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(output_msg) = stream.message().<span class="kw">await</span>.unwrap() { |
| <span class="macro">assert_eq!</span>(output_msg.len(), msg.len()); |
| i += <span class="number">1</span>; |
| } |
| <span class="macro">assert_eq!</span>(i, <span class="number">1</span>); |
| } |
| |
| <span class="attribute">#[tokio::test] |
| </span><span class="kw">async fn </span>encode() { |
| <span class="kw">let </span>encoder = MockEncoder::default(); |
| |
| <span class="kw">let </span>msg = Vec::from(<span class="kw-2">&</span>[<span class="number">0u8</span>; <span class="number">1024</span>][..]); |
| |
| <span class="kw">let </span>messages = std::iter::repeat_with(<span class="kw">move </span>|| <span class="prelude-val">Ok</span>::<<span class="kw">_</span>, Status>(msg.clone())).take(<span class="number">10000</span>); |
| <span class="kw">let </span>source = futures_util::stream::iter(messages); |
| |
| <span class="kw">let </span>body = encode_server( |
| encoder, |
| source, |
| <span class="prelude-val">None</span>, |
| SingleMessageCompressionOverride::default(), |
| ); |
| |
| <span class="macro">futures_util::pin_mut!</span>(body); |
| |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(r) = body.data().<span class="kw">await </span>{ |
| r.unwrap(); |
| } |
| } |
| |
| <span class="attribute">#[derive(Debug, Clone, Default)] |
| </span><span class="kw">struct </span>MockEncoder; |
| |
| <span class="kw">impl </span>Encoder <span class="kw">for </span>MockEncoder { |
| <span class="kw">type </span>Item = Vec<u8>; |
| <span class="kw">type </span>Error = Status; |
| |
| <span class="kw">fn </span>encode(<span class="kw-2">&mut </span><span class="self">self</span>, item: <span class="self">Self</span>::Item, buf: <span class="kw-2">&mut </span>EncodeBuf<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error> { |
| buf.put(<span class="kw-2">&</span>item[..]); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="attribute">#[derive(Debug, Clone, Default)] |
| </span><span class="kw">struct </span>MockDecoder; |
| |
| <span class="kw">impl </span>Decoder <span class="kw">for </span>MockDecoder { |
| <span class="kw">type </span>Item = Vec<u8>; |
| <span class="kw">type </span>Error = Status; |
| |
| <span class="kw">fn </span>decode(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <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> { |
| <span class="kw">let </span>out = Vec::from(buf.chunk()); |
| buf.advance(LEN); |
| <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(out)) |
| } |
| } |
| |
| <span class="kw">mod </span>body { |
| <span class="kw">use </span><span class="kw">crate</span>::Status; |
| <span class="kw">use </span>bytes::Bytes; |
| <span class="kw">use </span>http_body::Body; |
| <span class="kw">use </span>std::{ |
| pin::Pin, |
| task::{Context, Poll}, |
| }; |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>MockBody { |
| data: Bytes, |
| |
| <span class="comment">// the size of the partial message to send |
| </span>partial_len: usize, |
| |
| <span class="comment">// the number of times we've sent |
| </span>count: usize, |
| } |
| |
| <span class="kw">impl </span>MockBody { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(b: <span class="kw-2">&</span>[u8], partial_len: usize, count: usize) -> <span class="self">Self </span>{ |
| MockBody { |
| data: Bytes::copy_from_slice(b), |
| partial_len, |
| count, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Body <span class="kw">for </span>MockBody { |
| <span class="kw">type </span>Data = Bytes; |
| <span class="kw">type </span>Error = Status; |
| |
| <span class="kw">fn </span>poll_data( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Option</span><<span class="prelude-ty">Result</span><<span class="self">Self</span>::Data, <span class="self">Self</span>::Error>>> { |
| <span class="comment">// every other call to poll_data returns data |
| </span><span class="kw">let </span>should_send = <span class="self">self</span>.count % <span class="number">2 </span>== <span class="number">0</span>; |
| <span class="kw">let </span>data_len = <span class="self">self</span>.data.len(); |
| <span class="kw">let </span>partial_len = <span class="self">self</span>.partial_len; |
| <span class="kw">let </span>count = <span class="self">self</span>.count; |
| <span class="kw">if </span>data_len > <span class="number">0 </span>{ |
| <span class="kw">let </span>result = <span class="kw">if </span>should_send { |
| <span class="kw">let </span>response = |
| <span class="self">self</span>.data |
| .split_to(<span class="kw">if </span>count == <span class="number">0 </span>{ partial_len } <span class="kw">else </span>{ data_len }); |
| Poll::Ready(<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(response))) |
| } <span class="kw">else </span>{ |
| cx.waker().wake_by_ref(); |
| Poll::Pending |
| }; |
| <span class="comment">// make some fake progress |
| </span><span class="self">self</span>.count += <span class="number">1</span>; |
| result |
| } <span class="kw">else </span>{ |
| Poll::Ready(<span class="prelude-val">None</span>) |
| } |
| } |
| |
| <span class="attribute">#[allow(clippy::drop_ref)] |
| </span><span class="kw">fn </span>poll_trailers( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<<span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><http::HeaderMap>, <span class="self">Self</span>::Error>> { |
| drop(cx); |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)) |
| } |
| } |
| } |
| } |
| </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> |