| <!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/tower-0.4.13/src/builder/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tower/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tower/index.html"><img class="rust-logo" src="../../../rust-logo.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> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Builder types to compose layers and services |
| |
| </span><span class="kw">use </span>tower_layer::{Identity, Layer, Stack}; |
| <span class="kw">use </span>tower_service::Service; |
| |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// Declaratively construct [`Service`] values. |
| /// |
| /// [`ServiceBuilder`] provides a [builder-like interface][builder] for composing |
| /// layers to be applied to a [`Service`]. |
| /// |
| /// # Service |
| /// |
| /// A [`Service`] is a trait representing an asynchronous function of a request |
| /// to a response. It is similar to `async fn(Request) -> Result<Response, Error>`. |
| /// |
| /// A [`Service`] is typically bound to a single transport, such as a TCP |
| /// connection. It defines how _all_ inbound or outbound requests are handled |
| /// by that connection. |
| /// |
| /// [builder]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html |
| /// |
| /// # Order |
| /// |
| /// The order in which layers are added impacts how requests are handled. Layers |
| /// that are added first will be called with the request first. The argument to |
| /// `service` will be last to see the request. |
| /// |
| /// ``` |
| /// # // this (and other) doctest is ignored because we don't have a way |
| /// # // to say that it should only be run with cfg(feature = "...") |
| /// # use tower::Service; |
| /// # use tower::builder::ServiceBuilder; |
| /// # #[cfg(all(feature = "buffer", feature = "limit"))] |
| /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send { |
| /// ServiceBuilder::new() |
| /// .buffer(100) |
| /// .concurrency_limit(10) |
| /// .service(svc) |
| /// # ; |
| /// # } |
| /// ``` |
| /// |
| /// In the above example, the buffer layer receives the request first followed |
| /// by `concurrency_limit`. `buffer` enables up to 100 request to be in-flight |
| /// **on top of** the requests that have already been forwarded to the next |
| /// layer. Combined with `concurrency_limit`, this allows up to 110 requests to be |
| /// in-flight. |
| /// |
| /// ``` |
| /// # use tower::Service; |
| /// # use tower::builder::ServiceBuilder; |
| /// # #[cfg(all(feature = "buffer", feature = "limit"))] |
| /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send { |
| /// ServiceBuilder::new() |
| /// .concurrency_limit(10) |
| /// .buffer(100) |
| /// .service(svc) |
| /// # ; |
| /// # } |
| /// ``` |
| /// |
| /// The above example is similar, but the order of layers is reversed. Now, |
| /// `concurrency_limit` applies first and only allows 10 requests to be in-flight |
| /// total. |
| /// |
| /// # Examples |
| /// |
| /// A [`Service`] stack with a single layer: |
| /// |
| /// ``` |
| /// # use tower::Service; |
| /// # use tower::builder::ServiceBuilder; |
| /// # #[cfg(feature = "limit")] |
| /// # use tower::limit::concurrency::ConcurrencyLimitLayer; |
| /// # #[cfg(feature = "limit")] |
| /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send { |
| /// ServiceBuilder::new() |
| /// .concurrency_limit(5) |
| /// .service(svc); |
| /// # ; |
| /// # } |
| /// ``` |
| /// |
| /// A [`Service`] stack with _multiple_ layers that contain rate limiting, |
| /// in-flight request limits, and a channel-backed, clonable [`Service`]: |
| /// |
| /// ``` |
| /// # use tower::Service; |
| /// # use tower::builder::ServiceBuilder; |
| /// # use std::time::Duration; |
| /// # #[cfg(all(feature = "buffer", feature = "limit"))] |
| /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send { |
| /// ServiceBuilder::new() |
| /// .buffer(5) |
| /// .concurrency_limit(5) |
| /// .rate_limit(5, Duration::from_secs(1)) |
| /// .service(svc); |
| /// # ; |
| /// # } |
| /// ``` |
| /// |
| /// [`Service`]: crate::Service |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>ServiceBuilder<L> { |
| layer: L, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>ServiceBuilder<Identity> { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new() |
| } |
| } |
| |
| <span class="kw">impl </span>ServiceBuilder<Identity> { |
| <span class="doccomment">/// Create a new [`ServiceBuilder`]. |
| </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| ServiceBuilder { |
| layer: Identity::new(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><L> ServiceBuilder<L> { |
| <span class="doccomment">/// Add a new layer `T` into the [`ServiceBuilder`]. |
| /// |
| /// This wraps the inner service with the service provided by a user-defined |
| /// [`Layer`]. The provided layer must implement the [`Layer`] trait. |
| /// |
| /// [`Layer`]: crate::Layer |
| </span><span class="kw">pub fn </span>layer<T>(<span class="self">self</span>, layer: T) -> ServiceBuilder<Stack<T, L>> { |
| ServiceBuilder { |
| layer: Stack::new(layer, <span class="self">self</span>.layer), |
| } |
| } |
| |
| <span class="doccomment">/// Optionally add a new layer `T` into the [`ServiceBuilder`]. |
| /// |
| /// ``` |
| /// # use std::time::Duration; |
| /// # use tower::Service; |
| /// # use tower::builder::ServiceBuilder; |
| /// # use tower::timeout::TimeoutLayer; |
| /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send { |
| /// # let timeout = Some(Duration::new(10, 0)); |
| /// // Apply a timeout if configured |
| /// ServiceBuilder::new() |
| /// .option_layer(timeout.map(TimeoutLayer::new)) |
| /// .service(svc) |
| /// # ; |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>option_layer<T>( |
| <span class="self">self</span>, |
| layer: <span class="prelude-ty">Option</span><T>, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::Either<T, Identity>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::option_layer(layer)) |
| } |
| |
| <span class="doccomment">/// Add a [`Layer`] built from a function that accepts a service and returns another service. |
| /// |
| /// See the documentation for [`layer_fn`] for more details. |
| /// |
| /// [`layer_fn`]: crate::layer::layer_fn |
| </span><span class="kw">pub fn </span>layer_fn<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::layer::LayerFn<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::layer::layer_fn(f)) |
| } |
| |
| <span class="doccomment">/// Buffer requests when the next layer is not ready. |
| /// |
| /// This wraps the inner service with an instance of the [`Buffer`] |
| /// middleware. |
| /// |
| /// [`Buffer`]: crate::buffer |
| </span><span class="attribute">#[cfg(feature = <span class="string">"buffer"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"buffer"</span>)))] |
| </span><span class="kw">pub fn </span>buffer<Request>( |
| <span class="self">self</span>, |
| bound: usize, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::buffer::BufferLayer<Request>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::buffer::BufferLayer::new(bound)) |
| } |
| |
| <span class="doccomment">/// Limit the max number of in-flight requests. |
| /// |
| /// A request is in-flight from the time the request is received until the |
| /// response future completes. This includes the time spent in the next |
| /// layers. |
| /// |
| /// This wraps the inner service with an instance of the |
| /// [`ConcurrencyLimit`] middleware. |
| /// |
| /// [`ConcurrencyLimit`]: crate::limit::concurrency |
| </span><span class="attribute">#[cfg(feature = <span class="string">"limit"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"limit"</span>)))] |
| </span><span class="kw">pub fn </span>concurrency_limit( |
| <span class="self">self</span>, |
| max: usize, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::limit::ConcurrencyLimitLayer, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::limit::ConcurrencyLimitLayer::new(max)) |
| } |
| |
| <span class="doccomment">/// Drop requests when the next layer is unable to respond to requests. |
| /// |
| /// Usually, when a service or middleware does not have capacity to process a |
| /// request (i.e., [`poll_ready`] returns [`Pending`]), the caller waits until |
| /// capacity becomes available. |
| /// |
| /// [`LoadShed`] immediately responds with an error when the next layer is |
| /// out of capacity. |
| /// |
| /// This wraps the inner service with an instance of the [`LoadShed`] |
| /// middleware. |
| /// |
| /// [`LoadShed`]: crate::load_shed |
| /// [`poll_ready`]: crate::Service::poll_ready |
| /// [`Pending`]: std::task::Poll::Pending |
| </span><span class="attribute">#[cfg(feature = <span class="string">"load-shed"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"load-shed"</span>)))] |
| </span><span class="kw">pub fn </span>load_shed(<span class="self">self</span>) -> ServiceBuilder<Stack<<span class="kw">crate</span>::load_shed::LoadShedLayer, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::load_shed::LoadShedLayer::new()) |
| } |
| |
| <span class="doccomment">/// Limit requests to at most `num` per the given duration. |
| /// |
| /// This wraps the inner service with an instance of the [`RateLimit`] |
| /// middleware. |
| /// |
| /// [`RateLimit`]: crate::limit::rate |
| </span><span class="attribute">#[cfg(feature = <span class="string">"limit"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"limit"</span>)))] |
| </span><span class="kw">pub fn </span>rate_limit( |
| <span class="self">self</span>, |
| num: u64, |
| per: std::time::Duration, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::limit::RateLimitLayer, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::limit::RateLimitLayer::new(num, per)) |
| } |
| |
| <span class="doccomment">/// Retry failed requests according to the given [retry policy][policy]. |
| /// |
| /// `policy` determines which failed requests will be retried. It must |
| /// implement the [`retry::Policy`][policy] trait. |
| /// |
| /// This wraps the inner service with an instance of the [`Retry`] |
| /// middleware. |
| /// |
| /// [`Retry`]: crate::retry |
| /// [policy]: crate::retry::Policy |
| </span><span class="attribute">#[cfg(feature = <span class="string">"retry"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"retry"</span>)))] |
| </span><span class="kw">pub fn </span>retry<P>(<span class="self">self</span>, policy: P) -> ServiceBuilder<Stack<<span class="kw">crate</span>::retry::RetryLayer<P>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::retry::RetryLayer::new(policy)) |
| } |
| |
| <span class="doccomment">/// Fail requests that take longer than `timeout`. |
| /// |
| /// If the next layer takes more than `timeout` to respond to a request, |
| /// processing is terminated and an error is returned. |
| /// |
| /// This wraps the inner service with an instance of the [`timeout`] |
| /// middleware. |
| /// |
| /// [`timeout`]: crate::timeout |
| </span><span class="attribute">#[cfg(feature = <span class="string">"timeout"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"timeout"</span>)))] |
| </span><span class="kw">pub fn </span>timeout( |
| <span class="self">self</span>, |
| timeout: std::time::Duration, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::timeout::TimeoutLayer, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::timeout::TimeoutLayer::new(timeout)) |
| } |
| |
| <span class="doccomment">/// Conditionally reject requests based on `predicate`. |
| /// |
| /// `predicate` must implement the [`Predicate`] trait. |
| /// |
| /// This wraps the inner service with an instance of the [`Filter`] |
| /// middleware. |
| /// |
| /// [`Filter`]: crate::filter |
| /// [`Predicate`]: crate::filter::Predicate |
| </span><span class="attribute">#[cfg(feature = <span class="string">"filter"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"filter"</span>)))] |
| </span><span class="kw">pub fn </span>filter<P>( |
| <span class="self">self</span>, |
| predicate: P, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::filter::FilterLayer<P>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::filter::FilterLayer::new(predicate)) |
| } |
| |
| <span class="doccomment">/// Conditionally reject requests based on an asynchronous `predicate`. |
| /// |
| /// `predicate` must implement the [`AsyncPredicate`] trait. |
| /// |
| /// This wraps the inner service with an instance of the [`AsyncFilter`] |
| /// middleware. |
| /// |
| /// [`AsyncFilter`]: crate::filter::AsyncFilter |
| /// [`AsyncPredicate`]: crate::filter::AsyncPredicate |
| </span><span class="attribute">#[cfg(feature = <span class="string">"filter"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"filter"</span>)))] |
| </span><span class="kw">pub fn </span>filter_async<P>( |
| <span class="self">self</span>, |
| predicate: P, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::filter::AsyncFilterLayer<P>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::filter::AsyncFilterLayer::new(predicate)) |
| } |
| |
| <span class="doccomment">/// Map one request type to another. |
| /// |
| /// This wraps the inner service with an instance of the [`MapRequest`] |
| /// middleware. |
| /// |
| /// # Examples |
| /// |
| /// Changing the type of a request: |
| /// |
| /// ```rust |
| /// use tower::ServiceBuilder; |
| /// use tower::ServiceExt; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> Result<(), ()> { |
| /// // Suppose we have some `Service` whose request type is `String`: |
| /// let string_svc = tower::service_fn(|request: String| async move { |
| /// println!("request: {}", request); |
| /// Ok(()) |
| /// }); |
| /// |
| /// // ...but we want to call that service with a `usize`. What do we do? |
| /// |
| /// let usize_svc = ServiceBuilder::new() |
| /// // Add a middlware that converts the request type to a `String`: |
| /// .map_request(|request: usize| format!("{}", request)) |
| /// // ...and wrap the string service with that middleware: |
| /// .service(string_svc); |
| /// |
| /// // Now, we can call that service with a `usize`: |
| /// usize_svc.oneshot(42).await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// Modifying the request value: |
| /// |
| /// ```rust |
| /// use tower::ServiceBuilder; |
| /// use tower::ServiceExt; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> Result<(), ()> { |
| /// // A service that takes a number and returns it: |
| /// let svc = tower::service_fn(|request: usize| async move { |
| /// Ok(request) |
| /// }); |
| /// |
| /// let svc = ServiceBuilder::new() |
| /// // Add a middleware that adds 1 to each request |
| /// .map_request(|request: usize| request + 1) |
| /// .service(svc); |
| /// |
| /// let response = svc.oneshot(1).await?; |
| /// assert_eq!(response, 2); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`MapRequest`]: crate::util::MapRequest |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>map_request<F, R1, R2>( |
| <span class="self">self</span>, |
| f: F, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::MapRequestLayer<F>, L>> |
| <span class="kw">where |
| </span>F: FnMut(R1) -> R2 + Clone, |
| { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::MapRequestLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Map one response type to another. |
| /// |
| /// This wraps the inner service with an instance of the [`MapResponse`] |
| /// middleware. |
| /// |
| /// See the documentation for the [`map_response` combinator] for details. |
| /// |
| /// [`MapResponse`]: crate::util::MapResponse |
| /// [`map_response` combinator]: crate::util::ServiceExt::map_response |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>map_response<F>( |
| <span class="self">self</span>, |
| f: F, |
| ) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::MapResponseLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::MapResponseLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Map one error type to another. |
| /// |
| /// This wraps the inner service with an instance of the [`MapErr`] |
| /// middleware. |
| /// |
| /// See the documentation for the [`map_err` combinator] for details. |
| /// |
| /// [`MapErr`]: crate::util::MapErr |
| /// [`map_err` combinator]: crate::util::ServiceExt::map_err |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>map_err<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::MapErrLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::MapErrLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Composes a function that transforms futures produced by the service. |
| /// |
| /// This wraps the inner service with an instance of the [`MapFutureLayer`] middleware. |
| /// |
| /// See the documentation for the [`map_future`] combinator for details. |
| /// |
| /// [`MapFutureLayer`]: crate::util::MapFutureLayer |
| /// [`map_future`]: crate::util::ServiceExt::map_future |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>map_future<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::MapFutureLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::MapFutureLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Apply an asynchronous function after the service, regardless of whether the future |
| /// succeeds or fails. |
| /// |
| /// This wraps the inner service with an instance of the [`Then`] |
| /// middleware. |
| /// |
| /// This is similar to the [`map_response`] and [`map_err`] functions, |
| /// except that the *same* function is invoked when the service's future |
| /// completes, whether it completes successfully or fails. This function |
| /// takes the [`Result`] returned by the service's future, and returns a |
| /// [`Result`]. |
| /// |
| /// See the documentation for the [`then` combinator] for details. |
| /// |
| /// [`Then`]: crate::util::Then |
| /// [`then` combinator]: crate::util::ServiceExt::then |
| /// [`map_response`]: ServiceBuilder::map_response |
| /// [`map_err`]: ServiceBuilder::map_err |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>then<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::ThenLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::ThenLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Executes a new future after this service's future resolves. This does |
| /// not alter the behaviour of the [`poll_ready`] method. |
| /// |
| /// This method can be used to change the [`Response`] type of the service |
| /// into a different type. You can use this method to chain along a computation once the |
| /// service's response has been resolved. |
| /// |
| /// This wraps the inner service with an instance of the [`AndThen`] |
| /// middleware. |
| /// |
| /// See the documentation for the [`and_then` combinator] for details. |
| /// |
| /// [`Response`]: crate::Service::Response |
| /// [`poll_ready`]: crate::Service::poll_ready |
| /// [`and_then` combinator]: crate::util::ServiceExt::and_then |
| /// [`AndThen`]: crate::util::AndThen |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>and_then<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::AndThenLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::AndThenLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Maps this service's result type (`Result<Self::Response, Self::Error>`) |
| /// to a different value, regardless of whether the future succeeds or |
| /// fails. |
| /// |
| /// This wraps the inner service with an instance of the [`MapResult`] |
| /// middleware. |
| /// |
| /// See the documentation for the [`map_result` combinator] for details. |
| /// |
| /// [`map_result` combinator]: crate::util::ServiceExt::map_result |
| /// [`MapResult`]: crate::util::MapResult |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>map_result<F>(<span class="self">self</span>, f: F) -> ServiceBuilder<Stack<<span class="kw">crate</span>::util::MapResultLayer<F>, L>> { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::MapResultLayer::new(f)) |
| } |
| |
| <span class="doccomment">/// Returns the underlying `Layer` implementation. |
| </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> L { |
| <span class="self">self</span>.layer |
| } |
| |
| <span class="doccomment">/// Wrap the service `S` with the middleware provided by this |
| /// [`ServiceBuilder`]'s [`Layer`]'s, returning a new [`Service`]. |
| /// |
| /// [`Layer`]: crate::Layer |
| /// [`Service`]: crate::Service |
| </span><span class="kw">pub fn </span>service<S>(<span class="kw-2">&</span><span class="self">self</span>, service: S) -> L::Service |
| <span class="kw">where |
| </span>L: Layer<S>, |
| { |
| <span class="self">self</span>.layer.layer(service) |
| } |
| |
| <span class="doccomment">/// Wrap the async function `F` with the middleware provided by this [`ServiceBuilder`]'s |
| /// [`Layer`]s, returning a new [`Service`]. |
| /// |
| /// This is a convenience method which is equivalent to calling |
| /// [`ServiceBuilder::service`] with a [`service_fn`], like this: |
| /// |
| /// ```rust |
| /// # use tower::{ServiceBuilder, service_fn}; |
| /// # async fn handler_fn(_: ()) -> Result<(), ()> { Ok(()) } |
| /// # let _ = { |
| /// ServiceBuilder::new() |
| /// // ... |
| /// .service(service_fn(handler_fn)) |
| /// # }; |
| /// ``` |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use std::time::Duration; |
| /// use tower::{ServiceBuilder, ServiceExt, BoxError, service_fn}; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> Result<(), BoxError> { |
| /// async fn handle(request: &'static str) -> Result<&'static str, BoxError> { |
| /// Ok(request) |
| /// } |
| /// |
| /// let svc = ServiceBuilder::new() |
| /// .buffer(1024) |
| /// .timeout(Duration::from_secs(10)) |
| /// .service_fn(handle); |
| /// |
| /// let response = svc.oneshot("foo").await?; |
| /// |
| /// assert_eq!(response, "foo"); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`Layer`]: crate::Layer |
| /// [`Service`]: crate::Service |
| /// [`service_fn`]: crate::service_fn |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>service_fn<F>(<span class="self">self</span>, f: F) -> L::Service |
| <span class="kw">where |
| </span>L: Layer<<span class="kw">crate</span>::util::ServiceFn<F>>, |
| { |
| <span class="self">self</span>.service(<span class="kw">crate</span>::util::service_fn(f)) |
| } |
| |
| <span class="doccomment">/// Check that the builder implements `Clone`. |
| /// |
| /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers. |
| /// |
| /// Doesn't actually change the builder but serves as a type check. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tower::ServiceBuilder; |
| /// |
| /// let builder = ServiceBuilder::new() |
| /// // Do something before processing the request |
| /// .map_request(|request: String| { |
| /// println!("got request!"); |
| /// request |
| /// }) |
| /// // Ensure our `ServiceBuilder` can be cloned |
| /// .check_clone() |
| /// // Do something after processing the request |
| /// .map_response(|response: String| { |
| /// println!("got response!"); |
| /// response |
| /// }); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>check_clone(<span class="self">self</span>) -> <span class="self">Self |
| </span><span class="kw">where |
| </span><span class="self">Self</span>: Clone, |
| { |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Check that the builder when given a service of type `S` produces a service that implements |
| /// `Clone`. |
| /// |
| /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers. |
| /// |
| /// Doesn't actually change the builder but serves as a type check. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tower::ServiceBuilder; |
| /// |
| /// # #[derive(Clone)] |
| /// # struct MyService; |
| /// # |
| /// let builder = ServiceBuilder::new() |
| /// // Do something before processing the request |
| /// .map_request(|request: String| { |
| /// println!("got request!"); |
| /// request |
| /// }) |
| /// // Ensure that the service produced when given a `MyService` implements |
| /// .check_service_clone::<MyService>() |
| /// // Do something after processing the request |
| /// .map_response(|response: String| { |
| /// println!("got response!"); |
| /// response |
| /// }); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>check_service_clone<S>(<span class="self">self</span>) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>L: Layer<S>, |
| L::Service: Clone, |
| { |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Check that the builder when given a service of type `S` produces a service with the given |
| /// request, response, and error types. |
| /// |
| /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers. |
| /// |
| /// Doesn't actually change the builder but serves as a type check. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tower::ServiceBuilder; |
| /// use std::task::{Poll, Context}; |
| /// use tower::{Service, ServiceExt}; |
| /// |
| /// // An example service |
| /// struct MyService; |
| /// |
| /// impl Service<Request> for MyService { |
| /// type Response = Response; |
| /// type Error = Error; |
| /// type Future = futures_util::future::Ready<Result<Response, Error>>; |
| /// |
| /// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> { |
| /// // ... |
| /// # todo!() |
| /// } |
| /// |
| /// fn call(&mut self, request: Request) -> Self::Future { |
| /// // ... |
| /// # todo!() |
| /// } |
| /// } |
| /// |
| /// struct Request; |
| /// struct Response; |
| /// struct Error; |
| /// |
| /// struct WrappedResponse(Response); |
| /// |
| /// let builder = ServiceBuilder::new() |
| /// // At this point in the builder if given a `MyService` it produces a service that |
| /// // accepts `Request`s, produces `Response`s, and fails with `Error`s |
| /// .check_service::<MyService, Request, Response, Error>() |
| /// // Wrap responses in `WrappedResponse` |
| /// .map_response(|response: Response| WrappedResponse(response)) |
| /// // Now the response type will be `WrappedResponse` |
| /// .check_service::<MyService, _, WrappedResponse, _>(); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>check_service<S, T, U, E>(<span class="self">self</span>) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>L: Layer<S>, |
| L::Service: Service<T, Response = U, Error = E>, |
| { |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// This wraps the inner service with the [`Layer`] returned by [`BoxService::layer()`]. |
| /// |
| /// See that method for more details. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use tower::{Service, ServiceBuilder, BoxError, util::BoxService}; |
| /// use std::time::Duration; |
| /// # |
| /// # struct Request; |
| /// # struct Response; |
| /// # impl Response { |
| /// # fn new() -> Self { Self } |
| /// # } |
| /// |
| /// let service: BoxService<Request, Response, BoxError> = ServiceBuilder::new() |
| /// .boxed() |
| /// .load_shed() |
| /// .concurrency_limit(64) |
| /// .timeout(Duration::from_secs(10)) |
| /// .service_fn(|req: Request| async { |
| /// Ok::<_, BoxError>(Response::new()) |
| /// }); |
| /// # let service = assert_service(service); |
| /// # fn assert_service<S, R>(svc: S) -> S |
| /// # where S: Service<R> { svc } |
| /// ``` |
| /// |
| /// [`BoxService::layer()`]: crate::util::BoxService::layer() |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>boxed<S, R>( |
| <span class="self">self</span>, |
| ) -> ServiceBuilder< |
| Stack< |
| tower_layer::LayerFn< |
| <span class="kw">fn</span>( |
| L::Service, |
| ) -> <span class="kw">crate</span>::util::BoxService< |
| R, |
| <L::Service <span class="kw">as </span>Service<R>>::Response, |
| <L::Service <span class="kw">as </span>Service<R>>::Error, |
| >, |
| >, |
| L, |
| >, |
| > |
| <span class="kw">where |
| </span>L: Layer<S>, |
| L::Service: Service<R> + Send + <span class="lifetime">'static</span>, |
| <L::Service <span class="kw">as </span>Service<R>>::Future: Send + <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::BoxService::layer()) |
| } |
| |
| <span class="doccomment">/// This wraps the inner service with the [`Layer`] returned by [`BoxCloneService::layer()`]. |
| /// |
| /// This is similar to the [`boxed`] method, but it requires that `Self` implement |
| /// [`Clone`], and the returned boxed service implements [`Clone`]. |
| /// |
| /// See [`BoxCloneService`] for more details. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use tower::{Service, ServiceBuilder, BoxError, util::BoxCloneService}; |
| /// use std::time::Duration; |
| /// # |
| /// # struct Request; |
| /// # struct Response; |
| /// # impl Response { |
| /// # fn new() -> Self { Self } |
| /// # } |
| /// |
| /// let service: BoxCloneService<Request, Response, BoxError> = ServiceBuilder::new() |
| /// .boxed_clone() |
| /// .load_shed() |
| /// .concurrency_limit(64) |
| /// .timeout(Duration::from_secs(10)) |
| /// .service_fn(|req: Request| async { |
| /// Ok::<_, BoxError>(Response::new()) |
| /// }); |
| /// # let service = assert_service(service); |
| /// |
| /// // The boxed service can still be cloned. |
| /// service.clone(); |
| /// # fn assert_service<S, R>(svc: S) -> S |
| /// # where S: Service<R> { svc } |
| /// ``` |
| /// |
| /// [`BoxCloneService::layer()`]: crate::util::BoxCloneService::layer() |
| /// [`BoxCloneService`]: crate::util::BoxCloneService |
| /// [`boxed`]: Self::boxed |
| </span><span class="attribute">#[cfg(feature = <span class="string">"util"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"util"</span>)))] |
| </span><span class="kw">pub fn </span>boxed_clone<S, R>( |
| <span class="self">self</span>, |
| ) -> ServiceBuilder< |
| Stack< |
| tower_layer::LayerFn< |
| <span class="kw">fn</span>( |
| L::Service, |
| ) -> <span class="kw">crate</span>::util::BoxCloneService< |
| R, |
| <L::Service <span class="kw">as </span>Service<R>>::Response, |
| <L::Service <span class="kw">as </span>Service<R>>::Error, |
| >, |
| >, |
| L, |
| >, |
| > |
| <span class="kw">where |
| </span>L: Layer<S>, |
| L::Service: Service<R> + Clone + Send + <span class="lifetime">'static</span>, |
| <L::Service <span class="kw">as </span>Service<R>>::Future: Send + <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.layer(<span class="kw">crate</span>::util::BoxCloneService::layer()) |
| } |
| } |
| |
| <span class="kw">impl</span><L: fmt::Debug> fmt::Debug <span class="kw">for </span>ServiceBuilder<L> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_tuple(<span class="string">"ServiceBuilder"</span>).field(<span class="kw-2">&</span><span class="self">self</span>.layer).finish() |
| } |
| } |
| |
| <span class="kw">impl</span><S, L> Layer<S> <span class="kw">for </span>ServiceBuilder<L> |
| <span class="kw">where |
| </span>L: Layer<S>, |
| { |
| <span class="kw">type </span>Service = L::Service; |
| |
| <span class="kw">fn </span>layer(<span class="kw-2">&</span><span class="self">self</span>, inner: S) -> <span class="self">Self</span>::Service { |
| <span class="self">self</span>.layer.layer(inner) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tower" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
