Files
mercator_service/src/actix_web/config.rs.html

697 lines
46 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 to the Rust file `/Users/sambuc/.cargo/registry/src/github.com-1ecc6299db9ec823/actix-web-1.0.9/src/config.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>config.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../actix_web/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</span>;
<span class="kw">use</span> <span class="ident">actix_http</span>::<span class="ident">Extensions</span>;
<span class="kw">use</span> <span class="ident">actix_router</span>::<span class="ident">ResourceDef</span>;
<span class="kw">use</span> <span class="ident">actix_service</span>::{<span class="ident">boxed</span>, <span class="ident">IntoNewService</span>, <span class="ident">NewService</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">data</span>::{<span class="ident">Data</span>, <span class="ident">DataFactory</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">guard</span>::<span class="ident">Guard</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">resource</span>::<span class="ident">Resource</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">rmap</span>::<span class="ident">ResourceMap</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">route</span>::<span class="ident">Route</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">service</span>::{
<span class="ident">HttpServiceFactory</span>, <span class="ident">ServiceFactory</span>, <span class="ident">ServiceFactoryWrapper</span>, <span class="ident">ServiceRequest</span>,
<span class="ident">ServiceResponse</span>,
};
<span class="kw">type</span> <span class="ident">Guards</span> <span class="op">=</span> <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">Guard</span><span class="op">&gt;</span><span class="op">&gt;</span>;
<span class="kw">type</span> <span class="ident">HttpNewService</span> <span class="op">=</span>
<span class="ident">boxed</span>::<span class="ident">BoxedNewService</span><span class="op">&lt;</span>(), <span class="ident">ServiceRequest</span>, <span class="ident">ServiceResponse</span>, <span class="ident">Error</span>, ()<span class="op">&gt;</span>;
<span class="doccomment">/// Application configuration</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AppService</span> {
<span class="ident">config</span>: <span class="ident">AppConfig</span>,
<span class="ident">root</span>: <span class="ident">bool</span>,
<span class="ident">default</span>: <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">HttpNewService</span><span class="op">&gt;</span>,
<span class="ident">services</span>: <span class="ident">Vec</span><span class="op">&lt;</span>(
<span class="ident">ResourceDef</span>,
<span class="ident">HttpNewService</span>,
<span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Guards</span><span class="op">&gt;</span>,
<span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">ResourceMap</span><span class="op">&gt;</span><span class="op">&gt;</span>,
)<span class="op">&gt;</span>,
<span class="ident">service_data</span>: <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">DataFactory</span><span class="op">&gt;</span><span class="op">&gt;</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span> <span class="ident">AppService</span> {
<span class="doccomment">/// Crate server settings instance</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(
<span class="ident">config</span>: <span class="ident">AppConfig</span>,
<span class="ident">default</span>: <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">HttpNewService</span><span class="op">&gt;</span>,
<span class="ident">service_data</span>: <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">DataFactory</span><span class="op">&gt;</span><span class="op">&gt;</span><span class="op">&gt;</span>,
) <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="ident">AppService</span> {
<span class="ident">config</span>,
<span class="ident">default</span>,
<span class="ident">service_data</span>,
<span class="ident">root</span>: <span class="bool-val">true</span>,
<span class="ident">services</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(),
}
}
<span class="doccomment">/// Check if root is beeing configured</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_root</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">root</span>
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_services</span>(
<span class="self">self</span>,
) <span class="op">-</span><span class="op">&gt;</span> (
<span class="ident">AppConfig</span>,
<span class="ident">Vec</span><span class="op">&lt;</span>(
<span class="ident">ResourceDef</span>,
<span class="ident">HttpNewService</span>,
<span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Guards</span><span class="op">&gt;</span>,
<span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">ResourceMap</span><span class="op">&gt;</span><span class="op">&gt;</span>,
)<span class="op">&gt;</span>,
) {
(<span class="self">self</span>.<span class="ident">config</span>, <span class="self">self</span>.<span class="ident">services</span>)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">clone_config</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="ident">AppService</span> {
<span class="ident">config</span>: <span class="self">self</span>.<span class="ident">config</span>.<span class="ident">clone</span>(),
<span class="ident">default</span>: <span class="self">self</span>.<span class="ident">default</span>.<span class="ident">clone</span>(),
<span class="ident">services</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(),
<span class="ident">root</span>: <span class="bool-val">false</span>,
<span class="ident">service_data</span>: <span class="self">self</span>.<span class="ident">service_data</span>.<span class="ident">clone</span>(),
}
}
<span class="doccomment">/// Service configuration</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">config</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="ident">AppConfig</span> {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">config</span>
}
<span class="doccomment">/// Default resource</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">default_service</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">HttpNewService</span><span class="op">&gt;</span> {
<span class="self">self</span>.<span class="ident">default</span>.<span class="ident">clone</span>()
}
<span class="doccomment">/// Set global route data</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_service_data</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">extensions</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">Extensions</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span> {
<span class="kw">for</span> <span class="ident">f</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">service_data</span>.<span class="ident">iter</span>() {
<span class="ident">f</span>.<span class="ident">create</span>(<span class="ident">extensions</span>);
}
<span class="op">!</span><span class="self">self</span>.<span class="ident">service_data</span>.<span class="ident">is_empty</span>()
}
<span class="doccomment">/// Register http service</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">register_service</span><span class="op">&lt;</span><span class="ident">F</span>, <span class="ident">S</span><span class="op">&gt;</span>(
<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>,
<span class="ident">rdef</span>: <span class="ident">ResourceDef</span>,
<span class="ident">guards</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">Guard</span><span class="op">&gt;</span><span class="op">&gt;</span><span class="op">&gt;</span>,
<span class="ident">service</span>: <span class="ident">F</span>,
<span class="ident">nested</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">ResourceMap</span><span class="op">&gt;</span><span class="op">&gt;</span>,
) <span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">IntoNewService</span><span class="op">&lt;</span><span class="ident">S</span><span class="op">&gt;</span>,
<span class="ident">S</span>: <span class="ident">NewService</span><span class="op">&lt;</span>
<span class="ident">Config</span> <span class="op">=</span> (),
<span class="ident">Request</span> <span class="op">=</span> <span class="ident">ServiceRequest</span>,
<span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span>,
<span class="ident">Error</span> <span class="op">=</span> <span class="ident">Error</span>,
<span class="ident">InitError</span> <span class="op">=</span> (),
<span class="op">&gt;</span> <span class="op">+</span> <span class="lifetime">&#39;static</span>,
{
<span class="self">self</span>.<span class="ident">services</span>.<span class="ident">push</span>((
<span class="ident">rdef</span>,
<span class="ident">boxed</span>::<span class="ident">new_service</span>(<span class="ident">service</span>.<span class="ident">into_new_service</span>()),
<span class="ident">guards</span>,
<span class="ident">nested</span>,
));
}
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AppConfig</span>(<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">Rc</span><span class="op">&lt;</span><span class="ident">AppConfigInner</span><span class="op">&gt;</span>);
<span class="kw">impl</span> <span class="ident">AppConfig</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">inner</span>: <span class="ident">AppConfigInner</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="ident">AppConfig</span>(<span class="ident">Rc</span>::<span class="ident">new</span>(<span class="ident">inner</span>))
}
<span class="doccomment">/// Set server host name.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Host name is used by application router as a hostname for url</span>
<span class="doccomment">/// generation. Check [ConnectionInfo](./dev/struct.ConnectionInfo.</span>
<span class="doccomment">/// html#method.host) documentation for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// By default host name is set to a &quot;localhost&quot; value.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">host</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span> {
<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">host</span>
}
<span class="doccomment">/// Returns true if connection is secure(https)</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">secure</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">secure</span>
}
<span class="doccomment">/// Returns the socket address of the local half of this TCP connection</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">local_addr</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">SocketAddr</span> {
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">addr</span>
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">AppConfigInner</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">secure</span>: <span class="ident">bool</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">host</span>: <span class="ident">String</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">addr</span>: <span class="ident">SocketAddr</span>,
}
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">AppConfigInner</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="ident">AppConfigInner</span> {
<span class="ident">AppConfigInner</span> {
<span class="ident">secure</span>: <span class="bool-val">false</span>,
<span class="ident">addr</span>: <span class="string">&quot;127.0.0.1:8080&quot;</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>(),
<span class="ident">host</span>: <span class="string">&quot;localhost:8080&quot;</span>.<span class="ident">to_owned</span>(),
}
}
}
<span class="doccomment">/// Service config is used for external configuration.</span>
<span class="doccomment">/// Part of application configuration could be offloaded</span>
<span class="doccomment">/// to set of external methods. This could help with</span>
<span class="doccomment">/// modularization of big application configuration.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ServiceConfig</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">services</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">ServiceFactory</span><span class="op">&gt;</span><span class="op">&gt;</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">data</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">Box</span><span class="op">&lt;</span><span class="kw">dyn</span> <span class="ident">DataFactory</span><span class="op">&gt;</span><span class="op">&gt;</span>,
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">external</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">ResourceDef</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span> <span class="ident">ServiceConfig</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="self">Self</span> {
<span class="self">Self</span> {
<span class="ident">services</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(),
<span class="ident">data</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(),
<span class="ident">external</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(),
}
}
<span class="doccomment">/// Set application data. Application data could be accessed</span>
<span class="doccomment">/// by using `Data&lt;T&gt;` extractor where `T` is data type.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is same as `App::data()` method.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">data</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="lifetime">&#39;static</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">data</span>: <span class="ident">S</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">data</span>.<span class="ident">push</span>(<span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">Data</span>::<span class="ident">new</span>(<span class="ident">data</span>)));
<span class="self">self</span>
}
<span class="doccomment">/// Configure route for a specific path.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is same as `App::route()` method.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">route</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">path</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>, <span class="kw-2">mut</span> <span class="ident">route</span>: <span class="ident">Route</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">Self</span> {
<span class="self">self</span>.<span class="ident">service</span>(
<span class="ident">Resource</span>::<span class="ident">new</span>(<span class="ident">path</span>)
.<span class="ident">add_guards</span>(<span class="ident">route</span>.<span class="ident">take_guards</span>())
.<span class="ident">route</span>(<span class="ident">route</span>),
)
}
<span class="doccomment">/// Register http service.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is same as `App::service()` method.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">service</span><span class="op">&lt;</span><span class="ident">F</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">factory</span>: <span class="ident">F</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">HttpServiceFactory</span> <span class="op">+</span> <span class="lifetime">&#39;static</span>,
{
<span class="self">self</span>.<span class="ident">services</span>
.<span class="ident">push</span>(<span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">ServiceFactoryWrapper</span>::<span class="ident">new</span>(<span class="ident">factory</span>)));
<span class="self">self</span>
}
<span class="doccomment">/// Register an external resource.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// External resources are useful for URL generation purposes only</span>
<span class="doccomment">/// and are never considered for matching at request time. Calls to</span>
<span class="doccomment">/// `HttpRequest::url_for()` will work as expected.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is same as `App::external_service()` method.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">external_resource</span><span class="op">&lt;</span><span class="ident">N</span>, <span class="ident">U</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="ident">N</span>, <span class="ident">url</span>: <span class="ident">U</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">Self</span>
<span class="kw">where</span>
<span class="ident">N</span>: <span class="ident">AsRef</span><span class="op">&lt;</span><span class="ident">str</span><span class="op">&gt;</span>,
<span class="ident">U</span>: <span class="ident">AsRef</span><span class="op">&lt;</span><span class="ident">str</span><span class="op">&gt;</span>,
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rdef</span> <span class="op">=</span> <span class="ident">ResourceDef</span>::<span class="ident">new</span>(<span class="ident">url</span>.<span class="ident">as_ref</span>());
<span class="kw-2">*</span><span class="ident">rdef</span>.<span class="ident">name_mut</span>() <span class="op">=</span> <span class="ident">name</span>.<span class="ident">as_ref</span>().<span class="ident">to_string</span>();
<span class="self">self</span>.<span class="ident">external</span>.<span class="ident">push</span>(<span class="ident">rdef</span>);
<span class="self">self</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="ident">actix_service</span>::<span class="ident">Service</span>;
<span class="kw">use</span> <span class="ident">bytes</span>::<span class="ident">Bytes</span>;
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">http</span>::{<span class="ident">Method</span>, <span class="ident">StatusCode</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">test</span>::{<span class="ident">block_on</span>, <span class="ident">call_service</span>, <span class="ident">init_service</span>, <span class="ident">read_body</span>, <span class="ident">TestRequest</span>};
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_data</span>() {
<span class="kw">let</span> <span class="ident">cfg</span> <span class="op">=</span> <span class="op">|</span><span class="ident">cfg</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">ServiceConfig</span><span class="op">|</span> {
<span class="ident">cfg</span>.<span class="ident">data</span>(<span class="number">10usize</span>);
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">srv</span> <span class="op">=</span>
<span class="ident">init_service</span>(<span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">configure</span>(<span class="ident">cfg</span>).<span class="ident">service</span>(
<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">&quot;/&quot;</span>).<span class="ident">to</span>(<span class="op">|</span><span class="kw">_</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()),
));
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest</span>::<span class="ident">default</span>().<span class="ident">to_request</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">block_on</span>(<span class="ident">srv</span>.<span class="ident">call</span>(<span class="ident">req</span>)).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
}
<span class="comment">// #[test]</span>
<span class="comment">// fn test_data_factory() {</span>
<span class="comment">// let cfg = |cfg: &amp;mut ServiceConfig| {</span>
<span class="comment">// cfg.data_factory(|| {</span>
<span class="comment">// sleep(std::time::Duration::from_millis(50)).then(|_| {</span>
<span class="comment">// println!(&quot;READY&quot;);</span>
<span class="comment">// Ok::&lt;_, ()&gt;(10usize)</span>
<span class="comment">// })</span>
<span class="comment">// });</span>
<span class="comment">// };</span>
<span class="comment">// let mut srv =</span>
<span class="comment">// init_service(App::new().configure(cfg).service(</span>
<span class="comment">// web::resource(&quot;/&quot;).to(|_: web::Data&lt;usize&gt;| HttpResponse::Ok()),</span>
<span class="comment">// ));</span>
<span class="comment">// let req = TestRequest::default().to_request();</span>
<span class="comment">// let resp = block_on(srv.call(req)).unwrap();</span>
<span class="comment">// assert_eq!(resp.status(), StatusCode::OK);</span>
<span class="comment">// let cfg2 = |cfg: &amp;mut ServiceConfig| {</span>
<span class="comment">// cfg.data_factory(|| Ok::&lt;_, ()&gt;(10u32));</span>
<span class="comment">// };</span>
<span class="comment">// let mut srv = init_service(</span>
<span class="comment">// App::new()</span>
<span class="comment">// .service(web::resource(&quot;/&quot;).to(|_: web::Data&lt;usize&gt;| HttpResponse::Ok()))</span>
<span class="comment">// .configure(cfg2),</span>
<span class="comment">// );</span>
<span class="comment">// let req = TestRequest::default().to_request();</span>
<span class="comment">// let resp = block_on(srv.call(req)).unwrap();</span>
<span class="comment">// assert_eq!(resp.status(), StatusCode::INTERNAL_SERVER_ERROR);</span>
<span class="comment">// }</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_external_resource</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">init_service</span>(
<span class="ident">App</span>::<span class="ident">new</span>()
.<span class="ident">configure</span>(<span class="op">|</span><span class="ident">cfg</span><span class="op">|</span> {
<span class="ident">cfg</span>.<span class="ident">external_resource</span>(
<span class="string">&quot;youtube&quot;</span>,
<span class="string">&quot;https://youtube.com/watch/{video_id}&quot;</span>,
);
})
.<span class="ident">route</span>(
<span class="string">&quot;/test&quot;</span>,
<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="ident">req</span>: <span class="ident">HttpRequest</span><span class="op">|</span> {
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">body</span>(<span class="macro">format</span><span class="macro">!</span>(
<span class="string">&quot;{}&quot;</span>,
<span class="ident">req</span>.<span class="ident">url_for</span>(<span class="string">&quot;youtube&quot;</span>, <span class="kw-2">&amp;</span>[<span class="string">&quot;12345&quot;</span>]).<span class="ident">unwrap</span>()
))
}),
),
);
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest</span>::<span class="ident">with_uri</span>(<span class="string">&quot;/test&quot;</span>).<span class="ident">to_request</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">call_service</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">srv</span>, <span class="ident">req</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">read_body</span>(<span class="ident">resp</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">body</span>, <span class="ident">Bytes</span>::<span class="ident">from_static</span>(<span class="string">b&quot;https://youtube.com/watch/12345&quot;</span>));
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_service</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">init_service</span>(<span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">configure</span>(<span class="op">|</span><span class="ident">cfg</span><span class="op">|</span> {
<span class="ident">cfg</span>.<span class="ident">service</span>(
<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">&quot;/test&quot;</span>).<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">Created</span>())),
)
.<span class="ident">route</span>(<span class="string">&quot;/index.html&quot;</span>, <span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()));
}));
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest</span>::<span class="ident">with_uri</span>(<span class="string">&quot;/test&quot;</span>)
.<span class="ident">method</span>(<span class="ident">Method</span>::<span class="ident">GET</span>)
.<span class="ident">to_request</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">call_service</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">srv</span>, <span class="ident">req</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">CREATED</span>);
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest</span>::<span class="ident">with_uri</span>(<span class="string">&quot;/index.html&quot;</span>)
.<span class="ident">method</span>(<span class="ident">Method</span>::<span class="ident">GET</span>)
.<span class="ident">to_request</span>();
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">call_service</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">srv</span>, <span class="ident">req</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>