blob: de5f7bca65b419b3a6cdecf5151cffe5b74a5626 [file] [log] [blame]
<!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/encode.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>encode.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>
</pre><pre class="rust"><code><span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span><span class="kw">use </span><span class="kw">super</span>::compression::{compress, CompressionEncoding, SingleMessageCompressionOverride};
<span class="kw">use super</span>::{EncodeBuf, Encoder, HEADER_SIZE};
<span class="kw">use crate</span>::{Code, Status};
<span class="kw">use </span>bytes::{BufMut, Bytes, BytesMut};
<span class="kw">use </span>futures_core::{Stream, TryStream};
<span class="kw">use </span>futures_util::{ready, StreamExt, TryStreamExt};
<span class="kw">use </span>http::HeaderMap;
<span class="kw">use </span>http_body::Body;
<span class="kw">use </span>pin_project::pin_project;
<span class="kw">use </span>std::{
pin::Pin,
task::{Context, Poll},
};
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">const </span>BUFFER_SIZE: usize = <span class="number">8 </span>* <span class="number">1024</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_server&lt;T, U&gt;(
encoder: T,
source: U,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)] </span>compression_encoding: <span class="prelude-ty">Option</span>&lt;CompressionEncoding&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)] </span>compression_override: SingleMessageCompressionOverride,
) -&gt; EncodeBody&lt;<span class="kw">impl </span>Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;Bytes, Status&gt;&gt;&gt;
<span class="kw">where
</span>T: Encoder&lt;Error = Status&gt;,
U: Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;T::Item, Status&gt;&gt;,
{
<span class="kw">let </span>stream = encode(
encoder,
source,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span>compression_encoding,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span>compression_override,
)
.into_stream();
EncodeBody::new_server(stream)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_client&lt;T, U&gt;(
encoder: T,
source: U,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)] </span>compression_encoding: <span class="prelude-ty">Option</span>&lt;CompressionEncoding&gt;,
) -&gt; EncodeBody&lt;<span class="kw">impl </span>Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;Bytes, Status&gt;&gt;&gt;
<span class="kw">where
</span>T: Encoder&lt;Error = Status&gt;,
U: Stream&lt;Item = T::Item&gt;,
{
<span class="kw">let </span>stream = encode(
encoder,
source.map(<span class="prelude-val">Ok</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span>compression_encoding,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span>SingleMessageCompressionOverride::default(),
)
.into_stream();
EncodeBody::new_client(stream)
}
<span class="kw">fn </span>encode&lt;T, U&gt;(
<span class="kw-2">mut </span>encoder: T,
source: U,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)] </span>compression_encoding: <span class="prelude-ty">Option</span>&lt;CompressionEncoding&gt;,
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)] </span>compression_override: SingleMessageCompressionOverride,
) -&gt; <span class="kw">impl </span>TryStream&lt;<span class="prelude-val">Ok </span>= Bytes, Error = Status&gt;
<span class="kw">where
</span>T: Encoder&lt;Error = Status&gt;,
U: Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;T::Item, Status&gt;&gt;,
{
<span class="macro">async_stream::stream! </span>{
<span class="kw">let </span><span class="kw-2">mut </span>buf = BytesMut::with_capacity(BUFFER_SIZE);
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span><span class="kw">let </span>(compression_enabled_for_stream, <span class="kw-2">mut </span>uncompression_buf) = <span class="kw">match </span>compression_encoding {
<span class="prelude-val">Some</span>(CompressionEncoding::Gzip) =&gt; (<span class="bool-val">true</span>, BytesMut::with_capacity(BUFFER_SIZE)),
<span class="prelude-val">None </span>=&gt; (<span class="bool-val">false</span>, BytesMut::new()),
};
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span><span class="kw">let </span>compress_item = compression_enabled_for_stream &amp;&amp; compression_override == SingleMessageCompressionOverride::Inherit;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;compression&quot;</span>))]
</span><span class="kw">let </span>compress_item = <span class="bool-val">false</span>;
<span class="macro">futures_util::pin_mut!</span>(source);
<span class="kw">loop </span>{
<span class="kw">match </span>source.next().<span class="kw">await </span>{
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(item)) =&gt; {
buf.reserve(HEADER_SIZE);
<span class="kw">unsafe </span>{
buf.advance_mut(HEADER_SIZE);
}
<span class="kw">if </span>compress_item {
<span class="attribute">#[cfg(feature = <span class="string">&quot;compression&quot;</span>)]
</span>{
uncompression_buf.clear();
encoder.encode(item, <span class="kw-2">&amp;mut </span>EncodeBuf::new(<span class="kw-2">&amp;mut </span>uncompression_buf))
.map_err(|err| Status::internal(<span class="macro">format!</span>(<span class="string">&quot;Error encoding: {}&quot;</span>, err)))<span class="question-mark">?</span>;
<span class="kw">let </span>uncompressed_len = uncompression_buf.len();
compress(
compression_encoding.unwrap(),
<span class="kw-2">&amp;mut </span>uncompression_buf,
<span class="kw-2">&amp;mut </span>buf,
uncompressed_len,
).map_err(|err| Status::internal(<span class="macro">format!</span>(<span class="string">&quot;Error compressing: {}&quot;</span>, err)))<span class="question-mark">?</span>;
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;compression&quot;</span>))]
</span><span class="macro">unreachable!</span>(<span class="string">&quot;compression disabled, should not take this branch&quot;</span>);
} <span class="kw">else </span>{
encoder.encode(item, <span class="kw-2">&amp;mut </span>EncodeBuf::new(<span class="kw-2">&amp;mut </span>buf))
.map_err(|err| Status::internal(<span class="macro">format!</span>(<span class="string">&quot;Error encoding: {}&quot;</span>, err)))<span class="question-mark">?</span>;
}
<span class="comment">// now that we know length, we can write the header
</span><span class="kw">let </span>len = buf.len() - HEADER_SIZE;
<span class="macro">assert!</span>(len &lt;= std::u32::MAX <span class="kw">as </span>usize);
{
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="kw-2">&amp;mut </span>buf[..HEADER_SIZE];
buf.put_u8(compress_item <span class="kw">as </span>u8);
buf.put_u32(len <span class="kw">as </span>u32);
}
<span class="kw">yield </span><span class="prelude-val">Ok</span>(buf.split_to(len + HEADER_SIZE).freeze());
},
<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(status)) =&gt; <span class="kw">yield </span><span class="prelude-val">Err</span>(status),
<span class="prelude-val">None </span>=&gt; <span class="kw">break</span>,
}
}
}
}
<span class="attribute">#[derive(Debug)]
</span><span class="kw">enum </span>Role {
Client,
Server,
}
<span class="attribute">#[pin_project]
#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>EncodeBody&lt;S&gt; {
<span class="attribute">#[pin]
</span>inner: S,
error: <span class="prelude-ty">Option</span>&lt;Status&gt;,
role: Role,
is_end_stream: bool,
}
<span class="kw">impl</span>&lt;S&gt; EncodeBody&lt;S&gt;
<span class="kw">where
</span>S: Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;Bytes, Status&gt;&gt;,
{
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_client(inner: S) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
inner,
error: <span class="prelude-val">None</span>,
role: Role::Client,
is_end_stream: <span class="bool-val">false</span>,
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_server(inner: S) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
inner,
error: <span class="prelude-val">None</span>,
role: Role::Server,
is_end_stream: <span class="bool-val">false</span>,
}
}
}
<span class="kw">impl</span>&lt;S&gt; Body <span class="kw">for </span>EncodeBody&lt;S&gt;
<span class="kw">where
</span>S: Stream&lt;Item = <span class="prelude-ty">Result</span>&lt;Bytes, Status&gt;&gt;,
{
<span class="kw">type </span>Data = Bytes;
<span class="kw">type </span>Error = Status;
<span class="kw">fn </span>is_end_stream(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.is_end_stream
}
<span class="kw">fn </span>poll_data(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Data, <span class="self">Self</span>::Error&gt;&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>self_proj = <span class="self">self</span>.project();
<span class="kw">match </span><span class="macro">ready!</span>(self_proj.inner.try_poll_next_unpin(cx)) {
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(d)) =&gt; <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(d)).into(),
<span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(status)) =&gt; <span class="kw">match </span>self_proj.role {
Role::Client =&gt; <span class="prelude-val">Some</span>(<span class="prelude-val">Err</span>(status)).into(),
Role::Server =&gt; {
<span class="kw-2">*</span>self_proj.error = <span class="prelude-val">Some</span>(status);
<span class="prelude-val">None</span>.into()
}
},
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">None</span>.into(),
}
}
<span class="kw">fn </span>poll_trailers(
<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;,
_cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;<span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;HeaderMap&gt;, Status&gt;&gt; {
<span class="kw">match </span><span class="self">self</span>.role {
Role::Client =&gt; Poll::Ready(<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)),
Role::Server =&gt; {
<span class="kw">let </span>self_proj = <span class="self">self</span>.project();
<span class="kw">if </span><span class="kw-2">*</span>self_proj.is_end_stream {
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));
}
<span class="kw">let </span>status = <span class="kw">if let </span><span class="prelude-val">Some</span>(status) = self_proj.error.take() {
<span class="kw-2">*</span>self_proj.is_end_stream = <span class="bool-val">true</span>;
status
} <span class="kw">else </span>{
Status::new(Code::Ok, <span class="string">&quot;&quot;</span>)
};
Poll::Ready(<span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(status.to_header_map()<span class="question-mark">?</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>