blob: 9e4dc08ad7b179650baec1954f92601c70312371 [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/service/interceptor.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>interceptor.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>
</pre><pre class="rust"><code><span class="doccomment">//! gRPC interceptors which are a kind of middleware.
//!
//! See [`Interceptor`] for more details.
</span><span class="kw">use crate</span>::{request::SanitizeHeaders, Status};
<span class="kw">use </span>pin_project::pin_project;
<span class="kw">use </span>std::{
fmt,
future::Future,
pin::Pin,
task::{Context, Poll},
};
<span class="kw">use </span>tower_layer::Layer;
<span class="kw">use </span>tower_service::Service;
<span class="doccomment">/// A gRPC interceptor.
///
/// gRPC interceptors are similar to middleware but have less flexibility. An interceptor allows
/// you to do two main things, one is to add/remove/check items in the `MetadataMap` of each
/// request. Two, cancel a request with a `Status`.
///
/// Any function that satisfies the bound `FnMut(Request&lt;()&gt;) -&gt; Result&lt;Request&lt;()&gt;, Status&gt;` can be
/// used as an `Interceptor`.
///
/// An interceptor can be used on both the server and client side through the `tonic-build` crate&#39;s
/// generated structs.
///
/// See the [interceptor example][example] for more details.
///
/// If you need more powerful middleware, [tower] is the recommended approach. You can find
/// examples of how to use tower with tonic [here][tower-example].
///
/// Additionally, interceptors is not the recommended way to add logging to your service. For that
/// a [tower] middleware is more appropriate since it can also act on the response. For example
/// tower-http&#39;s [`Trace`](https://docs.rs/tower-http/latest/tower_http/trace/index.html)
/// middleware supports gRPC out of the box.
///
/// [tower]: https://crates.io/crates/tower
/// [example]: https://github.com/hyperium/tonic/tree/master/examples/src/interceptor
/// [tower-example]: https://github.com/hyperium/tonic/tree/master/examples/src/tower
</span><span class="kw">pub trait </span>Interceptor {
<span class="doccomment">/// Intercept a request before it is sent, optionally cancelling it.
</span><span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, request: <span class="kw">crate</span>::Request&lt;()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw">crate</span>::Request&lt;()&gt;, Status&gt;;
}
<span class="kw">impl</span>&lt;F&gt; Interceptor <span class="kw">for </span>F
<span class="kw">where
</span>F: FnMut(<span class="kw">crate</span>::Request&lt;()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw">crate</span>::Request&lt;()&gt;, Status&gt;,
{
<span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, request: <span class="kw">crate</span>::Request&lt;()&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw">crate</span>::Request&lt;()&gt;, Status&gt; {
<span class="self">self</span>(request)
}
}
<span class="doccomment">/// Create a new interceptor layer.
///
/// See [`Interceptor`] for more details.
</span><span class="kw">pub fn </span>interceptor&lt;F&gt;(f: F) -&gt; InterceptorLayer&lt;F&gt;
<span class="kw">where
</span>F: Interceptor,
{
InterceptorLayer { f }
}
<span class="attribute">#[deprecated(
since = <span class="string">&quot;0.5.1&quot;</span>,
note = <span class="string">&quot;Please use the `interceptor` function instead&quot;
</span>)]
</span><span class="doccomment">/// Create a new interceptor layer.
///
/// See [`Interceptor`] for more details.
</span><span class="kw">pub fn </span>interceptor_fn&lt;F&gt;(f: F) -&gt; InterceptorLayer&lt;F&gt;
<span class="kw">where
</span>F: Interceptor,
{
interceptor(f)
}
<span class="doccomment">/// A gRPC interceptor that can be used as a [`Layer`],
/// created by calling [`interceptor`].
///
/// See [`Interceptor`] for more details.
</span><span class="attribute">#[derive(Debug, Clone, Copy)]
</span><span class="kw">pub struct </span>InterceptorLayer&lt;F&gt; {
f: F,
}
<span class="kw">impl</span>&lt;S, F&gt; Layer&lt;S&gt; <span class="kw">for </span>InterceptorLayer&lt;F&gt;
<span class="kw">where
</span>F: Interceptor + Clone,
{
<span class="kw">type </span>Service = InterceptedService&lt;S, F&gt;;
<span class="kw">fn </span>layer(<span class="kw-2">&amp;</span><span class="self">self</span>, service: S) -&gt; <span class="self">Self</span>::Service {
InterceptedService::new(service, <span class="self">self</span>.f.clone())
}
}
<span class="attribute">#[deprecated(
since = <span class="string">&quot;0.5.1&quot;</span>,
note = <span class="string">&quot;Please use the `InterceptorLayer` type instead&quot;
</span>)]
</span><span class="doccomment">/// A gRPC interceptor that can be used as a [`Layer`],
/// created by calling [`interceptor`].
///
/// See [`Interceptor`] for more details.
</span><span class="kw">pub type </span>InterceptorFn&lt;F&gt; = InterceptorLayer&lt;F&gt;;
<span class="doccomment">/// A service wrapped in an interceptor middleware.
///
/// See [`Interceptor`] for more details.
</span><span class="attribute">#[derive(Clone, Copy)]
</span><span class="kw">pub struct </span>InterceptedService&lt;S, F&gt; {
inner: S,
f: F,
}
<span class="kw">impl</span>&lt;S, F&gt; InterceptedService&lt;S, F&gt; {
<span class="doccomment">/// Create a new `InterceptedService` that wraps `S` and intercepts each request with the
/// function `F`.
</span><span class="kw">pub fn </span>new(service: S, f: F) -&gt; <span class="self">Self
</span><span class="kw">where
</span>F: Interceptor,
{
<span class="self">Self </span>{ inner: service, f }
}
}
<span class="kw">impl</span>&lt;S, F&gt; fmt::Debug <span class="kw">for </span>InterceptedService&lt;S, F&gt;
<span class="kw">where
</span>S: fmt::Debug,
{
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;InterceptedService&quot;</span>)
.field(<span class="string">&quot;inner&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.inner)
.field(<span class="string">&quot;f&quot;</span>, <span class="kw-2">&amp;</span><span class="macro">format_args!</span>(<span class="string">&quot;{}&quot;</span>, std::any::type_name::&lt;F&gt;()))
.finish()
}
}
<span class="kw">impl</span>&lt;S, F, ReqBody, ResBody&gt; Service&lt;http::Request&lt;ReqBody&gt;&gt; <span class="kw">for </span>InterceptedService&lt;S, F&gt;
<span class="kw">where
</span>F: Interceptor,
S: Service&lt;http::Request&lt;ReqBody&gt;, Response = http::Response&lt;ResBody&gt;&gt;,
S::Error: Into&lt;<span class="kw">crate</span>::Error&gt;,
{
<span class="kw">type </span>Response = http::Response&lt;ResBody&gt;;
<span class="kw">type </span>Error = <span class="kw">crate</span>::Error;
<span class="kw">type </span>Future = ResponseFuture&lt;S::Future&gt;;
<span class="attribute">#[inline]
</span><span class="kw">fn </span>poll_ready(<span class="kw-2">&amp;mut </span><span class="self">self</span>, 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="self">Self</span>::Error&gt;&gt; {
<span class="self">self</span>.inner.poll_ready(cx).map_err(Into::into)
}
<span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, req: http::Request&lt;ReqBody&gt;) -&gt; <span class="self">Self</span>::Future {
<span class="kw">let </span>uri = req.uri().clone();
<span class="kw">let </span>req = <span class="kw">crate</span>::Request::from_http(req);
<span class="kw">let </span>(metadata, extensions, msg) = req.into_parts();
<span class="kw">match </span><span class="self">self
</span>.f
.call(<span class="kw">crate</span>::Request::from_parts(metadata, extensions, ()))
{
<span class="prelude-val">Ok</span>(req) =&gt; {
<span class="kw">let </span>(metadata, extensions, <span class="kw">_</span>) = req.into_parts();
<span class="kw">let </span>req = <span class="kw">crate</span>::Request::from_parts(metadata, extensions, msg);
<span class="kw">let </span>req = req.into_http(uri, SanitizeHeaders::No);
ResponseFuture::future(<span class="self">self</span>.inner.call(req))
}
<span class="prelude-val">Err</span>(status) =&gt; ResponseFuture::error(status),
}
}
}
<span class="comment">// required to use `InterceptedService` with `Router`
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;transport&quot;</span>)]
</span><span class="kw">impl</span>&lt;S, F&gt; <span class="kw">crate</span>::transport::NamedService <span class="kw">for </span>InterceptedService&lt;S, F&gt;
<span class="kw">where
</span>S: <span class="kw">crate</span>::transport::NamedService,
{
<span class="kw">const </span>NAME: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str = S::NAME;
}
<span class="doccomment">/// Response future for [`InterceptedService`].
</span><span class="attribute">#[pin_project]
#[derive(Debug)]
</span><span class="kw">pub struct </span>ResponseFuture&lt;F&gt; {
<span class="attribute">#[pin]
</span>kind: Kind&lt;F&gt;,
}
<span class="kw">impl</span>&lt;F&gt; ResponseFuture&lt;F&gt; {
<span class="kw">fn </span>future(future: F) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
kind: Kind::Future(future),
}
}
<span class="kw">fn </span>error(status: Status) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
kind: Kind::Error(<span class="prelude-val">Some</span>(status)),
}
}
}
<span class="attribute">#[pin_project(project = KindProj)]
#[derive(Debug)]
</span><span class="kw">enum </span>Kind&lt;F&gt; {
Future(<span class="attribute">#[pin] </span>F),
Error(<span class="prelude-ty">Option</span>&lt;Status&gt;),
}
<span class="kw">impl</span>&lt;F, E, B&gt; Future <span class="kw">for </span>ResponseFuture&lt;F&gt;
<span class="kw">where
</span>F: Future&lt;Output = <span class="prelude-ty">Result</span>&lt;http::Response&lt;B&gt;, E&gt;&gt;,
E: Into&lt;<span class="kw">crate</span>::Error&gt;,
{
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span>&lt;http::Response&lt;B&gt;, <span class="kw">crate</span>::Error&gt;;
<span class="kw">fn </span>poll(<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="self">Self</span>::Output&gt; {
<span class="kw">match </span><span class="self">self</span>.project().kind.project() {
KindProj::Future(future) =&gt; future.poll(cx).map_err(Into::into),
KindProj::Error(status) =&gt; {
<span class="kw">let </span>error = status.take().unwrap().into();
Poll::Ready(<span class="prelude-val">Err</span>(error))
}
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="attribute">#[allow(unused_imports)]
</span><span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>tower::ServiceExt;
<span class="attribute">#[tokio::test]
</span><span class="kw">async fn </span>doesnt_remove_headers() {
<span class="kw">let </span>svc = tower::service_fn(|request: http::Request&lt;hyper::Body&gt;| <span class="kw">async move </span>{
<span class="macro">assert_eq!</span>(
request
.headers()
.get(<span class="string">&quot;user-agent&quot;</span>)
.expect(<span class="string">&quot;missing in leaf service&quot;</span>),
<span class="string">&quot;test-tonic&quot;
</span>);
<span class="prelude-val">Ok</span>::&lt;<span class="kw">_</span>, hyper::Error&gt;(hyper::Response::new(hyper::Body::empty()))
});
<span class="kw">let </span>svc = InterceptedService::new(svc, |request: <span class="kw">crate</span>::Request&lt;()&gt;| {
<span class="macro">assert_eq!</span>(
request
.metadata()
.get(<span class="string">&quot;user-agent&quot;</span>)
.expect(<span class="string">&quot;missing in interceptor&quot;</span>),
<span class="string">&quot;test-tonic&quot;
</span>);
<span class="prelude-val">Ok</span>(request)
});
<span class="kw">let </span>request = http::Request::builder()
.header(<span class="string">&quot;user-agent&quot;</span>, <span class="string">&quot;test-tonic&quot;</span>)
.body(hyper::Body::empty())
.unwrap();
svc.oneshot(request).<span class="kw">await</span>.unwrap();
}
}
</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>