blob: cf61ad75c33d9141919ca9ae10c22c5c0a56c1b7 [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/request.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>request.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>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::metadata::{MetadataMap, MetadataValue};
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;transport&quot;</span>, feature = <span class="string">&quot;tls&quot;</span>))]
</span><span class="kw">use </span><span class="kw">crate</span>::transport::server::TlsConnectInfo;
<span class="attribute">#[cfg(feature = <span class="string">&quot;transport&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::transport::{server::TcpConnectInfo, Certificate};
<span class="kw">use </span><span class="kw">crate</span>::Extensions;
<span class="kw">use </span>futures_core::Stream;
<span class="attribute">#[cfg(feature = <span class="string">&quot;transport&quot;</span>)]
</span><span class="kw">use </span>std::sync::Arc;
<span class="kw">use </span>std::{net::SocketAddr, time::Duration};
<span class="doccomment">/// A gRPC request and metadata from an RPC call.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Request&lt;T&gt; {
metadata: MetadataMap,
message: T,
extensions: Extensions,
}
<span class="doccomment">/// Trait implemented by RPC request types.
///
/// Types implementing this trait can be used as arguments to client RPC
/// methods without explicitly wrapping them into `tonic::Request`s. The purpose
/// is to make client calls slightly more convenient to write.
///
/// Tonic&#39;s code generation and blanket implementations handle this for you,
/// so it is not necessary to implement this trait directly.
///
/// # Example
///
/// Given the following gRPC method definition:
/// ```proto
/// rpc GetFeature(Point) returns (Feature) {}
/// ```
///
/// we can call `get_feature` in two equivalent ways:
/// ```rust
/// # pub struct Point {}
/// # pub struct Client {}
/// # impl Client {
/// # fn get_feature(&amp;self, r: impl tonic::IntoRequest&lt;Point&gt;) {}
/// # }
/// # let client = Client {};
/// use tonic::Request;
///
/// client.get_feature(Point {});
/// client.get_feature(Request::new(Point {}));
/// ```
</span><span class="kw">pub trait </span>IntoRequest&lt;T&gt;: sealed::Sealed {
<span class="doccomment">/// Wrap the input message `T` in a `tonic::Request`
</span><span class="kw">fn </span>into_request(<span class="self">self</span>) -&gt; Request&lt;T&gt;;
}
<span class="doccomment">/// Trait implemented by RPC streaming request types.
///
/// Types implementing this trait can be used as arguments to client streaming
/// RPC methods without explicitly wrapping them into `tonic::Request`s. The
/// purpose is to make client calls slightly more convenient to write.
///
/// Tonic&#39;s code generation and blanket implementations handle this for you,
/// so it is not necessary to implement this trait directly.
///
/// # Example
///
/// Given the following gRPC service method definition:
/// ```proto
/// rpc RecordRoute(stream Point) returns (RouteSummary) {}
/// ```
/// we can call `record_route` in two equivalent ways:
///
/// ```rust
/// # #[derive(Clone)]
/// # pub struct Point {};
/// # pub struct Client {};
/// # impl Client {
/// # fn record_route(&amp;self, r: impl tonic::IntoStreamingRequest&lt;Message = Point&gt;) {}
/// # }
/// # let client = Client {};
/// use tonic::Request;
/// use futures_util::stream;
///
/// let messages = vec![Point {}, Point {}];
///
/// client.record_route(Request::new(stream::iter(messages.clone())));
/// client.record_route(stream::iter(messages));
/// ```
</span><span class="kw">pub trait </span>IntoStreamingRequest: sealed::Sealed {
<span class="doccomment">/// The RPC request stream type
</span><span class="kw">type </span>Stream: Stream&lt;Item = <span class="self">Self</span>::Message&gt; + Send + <span class="lifetime">&#39;static</span>;
<span class="doccomment">/// The RPC request type
</span><span class="kw">type </span>Message;
<span class="doccomment">/// Wrap the stream of messages in a `tonic::Request`
</span><span class="kw">fn </span>into_streaming_request(<span class="self">self</span>) -&gt; Request&lt;<span class="self">Self</span>::Stream&gt;;
}
<span class="kw">impl</span>&lt;T&gt; Request&lt;T&gt; {
<span class="doccomment">/// Create a new gRPC request.
///
/// ```rust
/// # use tonic::Request;
/// # pub struct HelloRequest {
/// # pub name: String,
/// # }
/// Request::new(HelloRequest {
/// name: &quot;Bob&quot;.into(),
/// });
/// ```
</span><span class="kw">pub fn </span>new(message: T) -&gt; <span class="self">Self </span>{
Request {
metadata: MetadataMap::new(),
message,
extensions: Extensions::new(),
}
}
<span class="doccomment">/// Get a reference to the message
</span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
<span class="kw-2">&amp;</span><span class="self">self</span>.message
}
<span class="doccomment">/// Get a mutable reference to the message
</span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>T {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.message
}
<span class="doccomment">/// Get a reference to the custom request metadata.
</span><span class="kw">pub fn </span>metadata(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>MetadataMap {
<span class="kw-2">&amp;</span><span class="self">self</span>.metadata
}
<span class="doccomment">/// Get a mutable reference to the request metadata.
</span><span class="kw">pub fn </span>metadata_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>MetadataMap {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.metadata
}
<span class="doccomment">/// Consumes `self`, returning the message
</span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; T {
<span class="self">self</span>.message
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_parts(<span class="self">self</span>) -&gt; (MetadataMap, Extensions, T) {
(<span class="self">self</span>.metadata, <span class="self">self</span>.extensions, <span class="self">self</span>.message)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_parts(metadata: MetadataMap, extensions: Extensions, message: T) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
metadata,
extensions,
message,
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_http_parts(parts: http::request::Parts, message: T) -&gt; <span class="self">Self </span>{
Request {
metadata: MetadataMap::from_headers(parts.headers),
message,
extensions: Extensions::from_http(parts.extensions),
}
}
<span class="doccomment">/// Convert an HTTP request to a gRPC request
</span><span class="kw">pub fn </span>from_http(http: http::Request&lt;T&gt;) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>(parts, message) = http.into_parts();
Request::from_http_parts(parts, message)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>into_http(
<span class="self">self</span>,
uri: http::Uri,
sanitize_headers: SanitizeHeaders,
) -&gt; http::Request&lt;T&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>request = http::Request::new(<span class="self">self</span>.message);
<span class="kw-2">*</span>request.version_mut() = http::Version::HTTP_2;
<span class="kw-2">*</span>request.method_mut() = http::Method::POST;
<span class="kw-2">*</span>request.uri_mut() = uri;
<span class="kw-2">*</span>request.headers_mut() = <span class="kw">match </span>sanitize_headers {
SanitizeHeaders::Yes =&gt; <span class="self">self</span>.metadata.into_sanitized_headers(),
SanitizeHeaders::No =&gt; <span class="self">self</span>.metadata.into_headers(),
};
<span class="kw-2">*</span>request.extensions_mut() = <span class="self">self</span>.extensions.into_http();
request
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>map&lt;F, U&gt;(<span class="self">self</span>, f: F) -&gt; Request&lt;U&gt;
<span class="kw">where
</span>F: FnOnce(T) -&gt; U,
{
<span class="kw">let </span>message = f(<span class="self">self</span>.message);
Request {
metadata: <span class="self">self</span>.metadata,
message,
extensions: <span class="self">self</span>.extensions,
}
}
<span class="doccomment">/// Get the remote address of this connection.
///
/// This will return `None` if the `IO` type used
/// does not implement `Connected`. This currently,
/// only works on the server side.
</span><span class="kw">pub fn </span>remote_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;SocketAddr&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;transport&quot;</span>)]
</span>{
<span class="attribute">#[cfg(feature = <span class="string">&quot;tls&quot;</span>)]
</span>{
<span class="self">self</span>.extensions()
.get::&lt;TcpConnectInfo&gt;()
.and_then(|i| i.remote_addr())
.or_else(|| {
<span class="self">self</span>.extensions()
.get::&lt;TlsConnectInfo&lt;TcpConnectInfo&gt;&gt;()
.and_then(|i| i.get_ref().remote_addr())
})
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;tls&quot;</span>))]
</span>{
<span class="self">self</span>.extensions()
.get::&lt;TcpConnectInfo&gt;()
.and_then(|i| i.remote_addr())
}
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;transport&quot;</span>))]
</span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Get the peer certificates of the connected client.
///
/// This is used to fetch the certificates from the TLS session
/// and is mostly used for mTLS. This currently only returns
/// `Some` on the server side of the `transport` server with
/// TLS enabled connections.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;transport&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;transport&quot;</span>)))]
</span><span class="kw">pub fn </span>peer_certs(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Arc&lt;Vec&lt;Certificate&gt;&gt;&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;tls&quot;</span>)]
</span>{
<span class="self">self</span>.extensions()
.get::&lt;TlsConnectInfo&lt;TcpConnectInfo&gt;&gt;()
.and_then(|i| i.peer_certs())
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;tls&quot;</span>))]
</span>{
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// Set the max duration the request is allowed to take.
///
/// Requires the server to support the `grpc-timeout` metadata, which Tonic does.
///
/// The duration will be formatted according to [the spec] and use the most precise unit
/// possible.
///
/// Example:
///
/// ```rust
/// use std::time::Duration;
/// use tonic::Request;
///
/// let mut request = Request::new(());
///
/// request.set_timeout(Duration::from_secs(30));
///
/// let value = request.metadata().get(&quot;grpc-timeout&quot;).unwrap();
///
/// assert_eq!(
/// value,
/// // equivalent to 30 seconds
/// &quot;30000000u&quot;
/// );
/// ```
///
/// [the spec]: https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md
</span><span class="kw">pub fn </span>set_timeout(<span class="kw-2">&amp;mut </span><span class="self">self</span>, deadline: Duration) {
<span class="kw">let </span>value = MetadataValue::from_str(<span class="kw-2">&amp;</span>duration_to_grpc_timeout(deadline)).unwrap();
<span class="self">self</span>.metadata_mut()
.insert(<span class="kw">crate</span>::metadata::GRPC_TIMEOUT_HEADER, value);
}
<span class="doccomment">/// Returns a reference to the associated extensions.
</span><span class="kw">pub fn </span>extensions(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Extensions {
<span class="kw-2">&amp;</span><span class="self">self</span>.extensions
}
<span class="doccomment">/// Returns a mutable reference to the associated extensions.
///
/// # Example
///
/// Extensions can be set in interceptors:
///
/// ```no_run
/// use tonic::{Request, service::interceptor};
///
/// struct MyExtension {
/// some_piece_of_data: String,
/// }
///
/// interceptor(|mut request: Request&lt;()&gt;| {
/// request.extensions_mut().insert(MyExtension {
/// some_piece_of_data: &quot;foo&quot;.to_string(),
/// });
///
/// Ok(request)
/// });
/// ```
///
/// And picked up by RPCs:
///
/// ```no_run
/// use tonic::{async_trait, Status, Request, Response};
/// #
/// # struct Output {}
/// # struct Input;
/// # struct MyService;
/// # struct MyExtension;
/// # #[async_trait]
/// # trait TestService {
/// # async fn handler(&amp;self, req: Request&lt;Input&gt;) -&gt; Result&lt;Response&lt;Output&gt;, Status&gt;;
/// # }
///
/// #[async_trait]
/// impl TestService for MyService {
/// async fn handler(&amp;self, req: Request&lt;Input&gt;) -&gt; Result&lt;Response&lt;Output&gt;, Status&gt; {
/// let value: &amp;MyExtension = req.extensions().get::&lt;MyExtension&gt;().unwrap();
///
/// Ok(Response::new(Output {}))
/// }
/// }
/// ```
</span><span class="kw">pub fn </span>extensions_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>Extensions {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.extensions
}
}
<span class="kw">impl</span>&lt;T&gt; IntoRequest&lt;T&gt; <span class="kw">for </span>T {
<span class="kw">fn </span>into_request(<span class="self">self</span>) -&gt; Request&lt;<span class="self">Self</span>&gt; {
Request::new(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;T&gt; IntoRequest&lt;T&gt; <span class="kw">for </span>Request&lt;T&gt; {
<span class="kw">fn </span>into_request(<span class="self">self</span>) -&gt; Request&lt;T&gt; {
<span class="self">self
</span>}
}
<span class="kw">impl</span>&lt;T&gt; IntoStreamingRequest <span class="kw">for </span>T
<span class="kw">where
</span>T: Stream + Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">type </span>Stream = T;
<span class="kw">type </span>Message = T::Item;
<span class="kw">fn </span>into_streaming_request(<span class="self">self</span>) -&gt; Request&lt;<span class="self">Self</span>&gt; {
Request::new(<span class="self">self</span>)
}
}
<span class="kw">impl</span>&lt;T&gt; IntoStreamingRequest <span class="kw">for </span>Request&lt;T&gt;
<span class="kw">where
</span>T: Stream + Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">type </span>Stream = T;
<span class="kw">type </span>Message = T::Item;
<span class="kw">fn </span>into_streaming_request(<span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">self
</span>}
}
<span class="kw">impl</span>&lt;T&gt; sealed::Sealed <span class="kw">for </span>T {}
<span class="kw">mod </span>sealed {
<span class="kw">pub trait </span>Sealed {}
}
<span class="kw">fn </span>duration_to_grpc_timeout(duration: Duration) -&gt; String {
<span class="kw">fn </span>try_format&lt;T: Into&lt;u128&gt;&gt;(
duration: Duration,
unit: char,
convert: <span class="kw">impl </span>FnOnce(Duration) -&gt; T,
) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<span class="comment">// The gRPC spec specifies that the timeout most be at most 8 digits. So this is the largest a
// value can be before we need to use a bigger unit.
</span><span class="kw">let </span>max_size: u128 = <span class="number">99_999_999</span>; <span class="comment">// exactly 8 digits
</span><span class="kw">let </span>value = convert(duration).into();
<span class="kw">if </span>value &gt; max_size {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">&quot;{}{}&quot;</span>, value, unit))
}
}
<span class="comment">// pick the most precise unit that is less than or equal to 8 digits as per the gRPC spec
</span>try_format(duration, <span class="string">&#39;n&#39;</span>, |d| d.as_nanos())
.or_else(|| try_format(duration, <span class="string">&#39;u&#39;</span>, |d| d.as_micros()))
.or_else(|| try_format(duration, <span class="string">&#39;m&#39;</span>, |d| d.as_millis()))
.or_else(|| try_format(duration, <span class="string">&#39;S&#39;</span>, |d| d.as_secs()))
.or_else(|| try_format(duration, <span class="string">&#39;M&#39;</span>, |d| d.as_secs() / <span class="number">60</span>))
.or_else(|| {
try_format(duration, <span class="string">&#39;H&#39;</span>, |d| {
<span class="kw">let </span>minutes = d.as_secs() / <span class="number">60</span>;
minutes / <span class="number">60
</span>})
})
<span class="comment">// duration has to be more than 11_415 years for this to happen
</span>.expect(<span class="string">&quot;duration is unrealistically large&quot;</span>)
}
<span class="doccomment">/// When converting a `tonic::Request` into a `http::Request` should reserved
/// headers be removed?
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>SanitizeHeaders {
Yes,
No,
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::metadata::MetadataValue;
<span class="kw">use </span>http::Uri;
<span class="attribute">#[test]
</span><span class="kw">fn </span>reserved_headers_are_excluded() {
<span class="kw">let </span><span class="kw-2">mut </span>r = Request::new(<span class="number">1</span>);
<span class="kw">for </span>header <span class="kw">in </span><span class="kw-2">&amp;</span>MetadataMap::GRPC_RESERVED_HEADERS {
r.metadata_mut()
.insert(<span class="kw-2">*</span>header, MetadataValue::from_static(<span class="string">&quot;invalid&quot;</span>));
}
<span class="kw">let </span>http_request = r.into_http(Uri::default(), SanitizeHeaders::Yes);
<span class="macro">assert!</span>(http_request.headers().is_empty());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>duration_to_grpc_timeout_less_than_second() {
<span class="kw">let </span>timeout = Duration::from_millis(<span class="number">500</span>);
<span class="kw">let </span>value = duration_to_grpc_timeout(timeout);
<span class="macro">assert_eq!</span>(value, <span class="macro">format!</span>(<span class="string">&quot;{}u&quot;</span>, timeout.as_micros()));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>duration_to_grpc_timeout_more_than_second() {
<span class="kw">let </span>timeout = Duration::from_secs(<span class="number">30</span>);
<span class="kw">let </span>value = duration_to_grpc_timeout(timeout);
<span class="macro">assert_eq!</span>(value, <span class="macro">format!</span>(<span class="string">&quot;{}u&quot;</span>, timeout.as_micros()));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>duration_to_grpc_timeout_a_very_long_time() {
<span class="kw">let </span>one_hour = Duration::from_secs(<span class="number">60 </span>* <span class="number">60</span>);
<span class="kw">let </span>value = duration_to_grpc_timeout(one_hour);
<span class="macro">assert_eq!</span>(value, <span class="macro">format!</span>(<span class="string">&quot;{}m&quot;</span>, one_hour.as_millis()));
}
}
</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>