diff options
| author | Teddy Wing | 2020-07-04 18:00:45 +0200 |
|---|---|---|
| committer | Teddy Wing | 2020-07-04 18:14:31 +0200 |
| commit | 52e6473446d3fa3ab03586ce66d45cb99493c0a1 (patch) | |
| tree | b985878838a6925170e12abcd8390cd29890dd5b /src/fastcgi_conduit/request.rs.html | |
| parent | 95637c5ca6c803bec78687a55afcc2d3f2bf6ff4 (diff) | |
| download | fastcgi-conduit-52e6473446d3fa3ab03586ce66d45cb99493c0a1.tar.bz2 | |
Generate docs v0.1.0gh-pages
Diffstat (limited to 'src/fastcgi_conduit/request.rs.html')
| -rw-r--r-- | src/fastcgi_conduit/request.rs.html | 577 |
1 files changed, 577 insertions, 0 deletions
diff --git a/src/fastcgi_conduit/request.rs.html b/src/fastcgi_conduit/request.rs.html new file mode 100644 index 0000000..6ca8ef6 --- /dev/null +++ b/src/fastcgi_conduit/request.rs.html @@ -0,0 +1,577 @@ +<!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 `src/request.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>request.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">☰</div><a href='../../fastcgi_conduit/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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="comment">// Copyright (c) 2020 Teddy Wing</span> +<span class="comment">//</span> +<span class="comment">// This file is part of FastCGI-Conduit.</span> +<span class="comment">//</span> +<span class="comment">// FastCGI-Conduit is free software: you can redistribute it and/or modify</span> +<span class="comment">// it under the terms of the GNU General Public License as published by</span> +<span class="comment">// the Free Software Foundation, either version 3 of the License, or</span> +<span class="comment">// (at your option) any later version.</span> +<span class="comment">//</span> +<span class="comment">// FastCGI-Conduit is distributed in the hope that it will be useful,</span> +<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span> +<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> +<span class="comment">// GNU General Public License for more details.</span> +<span class="comment">//</span> +<span class="comment">// You should have received a copy of the GNU General Public License</span> +<span class="comment">// along with FastCGI-Conduit. If not, see <https://www.gnu.org/licenses/>.</span> + +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>; +<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">inflector</span>::<span class="ident">cases</span>::<span class="ident">traincase</span>::<span class="ident">to_train_case</span>; + +<span class="kw">use</span> <span class="ident">snafu</span>::{<span class="ident">ResultExt</span>, <span class="ident">Snafu</span>}; + + +<span class="doccomment">/// Errors parsing a FastCGI request.</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Snafu</span>)]</span> +<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> { + <span class="doccomment">/// The HTTP method is invalid.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">context</span>(<span class="bool-val">false</span>))]</span> + <span class="ident">InvalidMethod</span> { <span class="ident">source</span>: <span class="ident">http</span>::<span class="ident">method</span>::<span class="ident">InvalidMethod</span> }, + + <span class="doccomment">/// An invalid HTTP header name.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">context</span>(<span class="bool-val">false</span>))]</span> + <span class="ident">InvalidHeaderName</span> { <span class="ident">source</span>: <span class="ident">conduit</span>::<span class="ident">header</span>::<span class="ident">InvalidHeaderName</span> }, + + <span class="doccomment">/// An invalid HTTP header value.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">context</span>(<span class="bool-val">false</span>))]</span> + <span class="ident">InvalidHeaderValue</span> { <span class="ident">source</span>: <span class="ident">conduit</span>::<span class="ident">header</span>::<span class="ident">InvalidHeaderValue</span> }, + + <span class="doccomment">/// An invalid remote address.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">context</span>(<span class="bool-val">false</span>))]</span> + <span class="ident">InvalidRemoteAddr</span> { <span class="ident">source</span>: <span class="ident">RemoteAddrError</span> }, +} + +<span class="doccomment">/// A convenience `Result` that contains a request `Error`.</span> +<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">RequestResult</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span> <span class="op">=</span> <span class="ident">Error</span><span class="op">></span> <span class="op">=</span> <span class="ident">std</span>::<span class="ident">result</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span>; + +<span class="doccomment">/// Errors parsing an HTTP remote address.</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Snafu</span>)]</span> +<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">RemoteAddrError</span> { + <span class="doccomment">/// Error parsing the address part.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">display</span>(<span class="string">"Could not parse address {}: {}"</span>, <span class="ident">address</span>, <span class="ident">source</span>))]</span> + <span class="ident">AddrParseError</span> { + <span class="ident">address</span>: <span class="ident">String</span>, + <span class="ident">source</span>: <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">AddrParseError</span>, + }, + + <span class="doccomment">/// Error parsing the port part.</span> + <span class="attribute">#[<span class="ident">snafu</span>(<span class="ident">display</span>(<span class="string">"Could not parse port {}: {}"</span>, <span class="ident">port</span>, <span class="ident">source</span>))]</span> + <span class="ident">PortParseError</span> { + <span class="ident">port</span>: <span class="ident">String</span>, + <span class="ident">source</span>: <span class="ident">std</span>::<span class="ident">num</span>::<span class="ident">ParseIntError</span> + }, +} + + +<span class="doccomment">/// Wraps a [`fastcgi::Request`][fastcgi::Request] to implement</span> +<span class="doccomment">/// [`conduit::RequestExt`][conduit::RequestExt].</span> +<span class="doccomment">///</span> +<span class="doccomment">/// [fastcgi::Request]: ../../fastcgi/struct.Request.html</span> +<span class="doccomment">/// [conduit::RequestExt]: ../../conduit/trait.RequestExt.html</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FastCgiRequest</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { + <span class="ident">request</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">fastcgi</span>::<span class="ident">Request</span>, + <span class="ident">http_version</span>: <span class="ident">conduit</span>::<span class="ident">Version</span>, + <span class="ident">host</span>: <span class="ident">String</span>, + <span class="ident">method</span>: <span class="ident">conduit</span>::<span class="ident">Method</span>, + <span class="ident">headers</span>: <span class="ident">conduit</span>::<span class="ident">HeaderMap</span>, + <span class="ident">path</span>: <span class="ident">String</span>, + <span class="ident">query</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, + <span class="ident">remote_addr</span>: <span class="ident">SocketAddr</span>, + <span class="ident">content_length</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u64</span><span class="op">></span>, + <span class="ident">extensions</span>: <span class="ident">conduit</span>::<span class="ident">Extensions</span>, +} + +<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">FastCgiRequest</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { + <span class="doccomment">/// Create a new `FastCgiRequest`.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RequestResult</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> { + <span class="kw">let</span> <span class="ident">version</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">version</span>(<span class="ident">request</span>); + <span class="kw">let</span> <span class="ident">host</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">host</span>(<span class="ident">request</span>); + <span class="kw">let</span> <span class="ident">method</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">method</span>(<span class="ident">request</span>)<span class="question-mark">?</span>; + <span class="kw">let</span> <span class="ident">headers</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">headers</span>(<span class="ident">request</span>.<span class="ident">params</span>())<span class="question-mark">?</span>; + <span class="kw">let</span> <span class="ident">path</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">path</span>(<span class="ident">request</span>); + <span class="kw">let</span> <span class="ident">query</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">query</span>(<span class="ident">request</span>); + <span class="kw">let</span> <span class="ident">remote_addr</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">remote_addr</span>(<span class="ident">request</span>)<span class="question-mark">?</span>; + <span class="kw">let</span> <span class="ident">content_length</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">content_length</span>(<span class="ident">request</span>); + + <span class="prelude-val">Ok</span>(<span class="self">Self</span> { + <span class="ident">request</span>: <span class="ident">request</span>, + <span class="ident">http_version</span>: <span class="ident">version</span>, + <span class="ident">host</span>: <span class="ident">host</span>, + <span class="ident">method</span>: <span class="ident">method</span>, + <span class="ident">headers</span>: <span class="ident">headers</span>, + <span class="ident">path</span>: <span class="ident">path</span>, + <span class="ident">query</span>: <span class="ident">query</span>, + <span class="ident">remote_addr</span>: <span class="ident">remote_addr</span>, + <span class="ident">content_length</span>: <span class="ident">content_length</span>, + <span class="ident">extensions</span>: <span class="ident">conduit</span>::<span class="ident">TypeMap</span>::<span class="ident">new</span>(), + }) + } + + <span class="doccomment">/// Extract the HTTP version.</span> + <span class="kw">fn</span> <span class="ident">version</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span> { + <span class="kw">match</span> <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"SERVER_PROTOCOL"</span>).<span class="ident">unwrap_or_default</span>().<span class="ident">as_str</span>() { + <span class="string">"HTTP/0.9"</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">HTTP_09</span>, + <span class="string">"HTTP/1.0"</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">HTTP_10</span>, + <span class="string">"HTTP/1.1"</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">HTTP_11</span>, + <span class="string">"HTTP/2.0"</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">HTTP_2</span>, + <span class="string">"HTTP/3.0"</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">HTTP_3</span>, + <span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span>::<span class="ident">default</span>(), + } + } + + <span class="doccomment">/// Get the request scheme (HTTP or HTTPS).</span> + <span class="kw">fn</span> <span class="ident">scheme</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Scheme</span> { + <span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"REQUEST_SCHEME"</span>).<span class="ident">unwrap_or_default</span>(); + + <span class="kw">if</span> <span class="ident">scheme</span> <span class="op">=</span><span class="op">=</span> <span class="string">"https"</span> { + <span class="ident">conduit</span>::<span class="ident">Scheme</span>::<span class="ident">Https</span> + } <span class="kw">else</span> { + <span class="ident">conduit</span>::<span class="ident">Scheme</span>::<span class="ident">Http</span> + } + } + + <span class="doccomment">/// Get the HTTP host.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// This looks like `localhost:8000`.</span> + <span class="kw">fn</span> <span class="ident">host</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> { + <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"HTTP_HOST"</span>).<span class="ident">unwrap_or_default</span>() + } + + <span class="doccomment">/// Get the HTTP method (GET, HEAD, POST, etc.).</span> + <span class="kw">fn</span> <span class="ident">method</span>( + <span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span> + ) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">conduit</span>::<span class="ident">Method</span>, <span class="ident">http</span>::<span class="ident">method</span>::<span class="ident">InvalidMethod</span><span class="op">></span> { + <span class="ident">conduit</span>::<span class="ident">Method</span>::<span class="ident">from_bytes</span>( + <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"REQUEST_METHOD"</span>) + .<span class="ident">unwrap_or_default</span>() + .<span class="ident">as_bytes</span>() + ) + } + + <span class="doccomment">/// Build a map of request headers.</span> + <span class="kw">fn</span> <span class="ident">headers</span>(<span class="ident">params</span>: <span class="ident">fastcgi</span>::<span class="ident">Params</span>) <span class="op">-</span><span class="op">></span> <span class="ident">RequestResult</span><span class="op"><</span><span class="ident">conduit</span>::<span class="ident">HeaderMap</span><span class="op">></span> { + <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">conduit</span>::<span class="ident">HeaderMap</span>::<span class="ident">new</span>(); + <span class="kw">let</span> <span class="ident">headers</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">headers_from_params</span>(<span class="ident">params</span>); + + <span class="kw">for</span> (<span class="ident">name</span>, <span class="ident">value</span>) <span class="kw">in</span> <span class="ident">headers</span> + .<span class="ident">iter</span>() + .<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">name</span>, <span class="ident">value</span>)<span class="op">|</span> (<span class="ident">name</span>.<span class="ident">as_bytes</span>(), <span class="ident">value</span>.<span class="ident">as_bytes</span>())) + { + <span class="ident">map</span>.<span class="ident">append</span>( + <span class="ident">conduit</span>::<span class="ident">header</span>::<span class="ident">HeaderName</span>::<span class="ident">from_bytes</span>(<span class="ident">name</span>)<span class="question-mark">?</span>, + <span class="ident">conduit</span>::<span class="ident">header</span>::<span class="ident">HeaderValue</span>::<span class="ident">from_bytes</span>(<span class="ident">value</span>)<span class="question-mark">?</span>, + ); + } + + <span class="prelude-val">Ok</span>(<span class="ident">map</span>) + } + + <span class="doccomment">/// Extract headers from request params. Transform these into pairs of</span> + <span class="doccomment">/// canonical header names and values.</span> + <span class="kw">fn</span> <span class="ident">headers_from_params</span>(<span class="ident">params</span>: <span class="ident">fastcgi</span>::<span class="ident">Params</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span>(<span class="ident">String</span>, <span class="ident">String</span>)<span class="op">></span> { + <span class="kw">return</span> <span class="ident">params</span> + .<span class="ident">filter</span>(<span class="op">|</span>(<span class="ident">key</span>, <span class="kw">_</span>)<span class="op">|</span> <span class="ident">key</span>.<span class="ident">starts_with</span>(<span class="string">"HTTP_"</span>)) + .<span class="ident">map</span>(<span class="op">|</span>(<span class="ident">key</span>, <span class="ident">value</span>)<span class="op">|</span> { + <span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">key</span>.<span class="ident">get</span>(<span class="number">5</span>..).<span class="ident">unwrap_or_default</span>(); + <span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">key</span>.<span class="ident">replace</span>(<span class="string">"_"</span>, <span class="string">"-"</span>); + <span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">to_train_case</span>(<span class="kw-2">&</span><span class="ident">key</span>); + + (<span class="ident">key</span>.<span class="ident">to_owned</span>(), <span class="ident">value</span>) + }) + .<span class="ident">collect</span>() + } + + <span class="doccomment">/// Get the URI path.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Returns `/path` when the URI is `http://localhost:8000/path?s=query`.</span> + <span class="doccomment">/// When the path is empty, returns `/`.</span> + <span class="kw">fn</span> <span class="ident">path</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> { + <span class="kw">match</span> <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"SCRIPT_NAME"</span>) { + <span class="prelude-val">Some</span>(<span class="ident">p</span>) <span class="op">=</span><span class="op">></span> <span class="ident">p</span>, + <span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="string">"/"</span>.<span class="ident">to_owned</span>(), + } + } + + <span class="doccomment">/// Get the URI query string.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Returns `s=query&lang=en` when the URI is</span> + <span class="doccomment">/// `http://localhost:8000/path?s=query&lang=en`.</span> + <span class="kw">fn</span> <span class="ident">query</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> { + <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"QUERY_STRING"</span>) + } + + <span class="doccomment">/// Get the remote address of the request.</span> + <span class="kw">fn</span> <span class="ident">remote_addr</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">SocketAddr</span>, <span class="ident">RemoteAddrError</span><span class="op">></span> { + <span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"REMOTE_ADDR"</span>).<span class="ident">unwrap_or_default</span>(); + <span class="kw">let</span> <span class="ident">port</span> <span class="op">=</span> <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"REMOTE_PORT"</span>).<span class="ident">unwrap_or_default</span>(); + + <span class="prelude-val">Ok</span>( + <span class="ident">SocketAddr</span>::<span class="ident">new</span>( + <span class="ident">addr</span>.<span class="ident">parse</span>().<span class="ident">context</span>(<span class="ident">AddrParseError</span> { <span class="ident">address</span>: <span class="ident">addr</span> })<span class="question-mark">?</span>, + <span class="ident">port</span>.<span class="ident">parse</span>().<span class="ident">context</span>(<span class="ident">PortParseError</span> { <span class="ident">port</span> })<span class="question-mark">?</span>, + ) + ) + } + + <span class="doccomment">/// Get the request's content length.</span> + <span class="kw">fn</span> <span class="ident">content_length</span>(<span class="ident">request</span>: <span class="kw-2">&</span><span class="ident">fastcgi</span>::<span class="ident">Request</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u64</span><span class="op">></span> { + <span class="ident">request</span>.<span class="ident">param</span>(<span class="string">"CONTENT_LENGTH"</span>).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">l</span><span class="op">|</span> <span class="ident">l</span>.<span class="ident">parse</span>().<span class="ident">ok</span>()) + } +} + +<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Read</span> <span class="kw">for</span> <span class="ident">FastCgiRequest</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { + <span class="doccomment">/// Read from the underlying FastCGI request's [`Stdin`][Stdin]</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [Stdin]: ../../fastcgi/struct.Stdin.html</span> + <span class="kw">fn</span> <span class="ident">read</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { + <span class="self">self</span>.<span class="ident">request</span>.<span class="ident">stdin</span>().<span class="ident">read</span>(<span class="ident">buf</span>) + } +} + +<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">RequestExt</span> <span class="kw">for</span> <span class="ident">FastCgiRequest</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { + <span class="kw">fn</span> <span class="ident">http_version</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Version</span> { + <span class="self">self</span>.<span class="ident">http_version</span> + } + + <span class="kw">fn</span> <span class="ident">method</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">conduit</span>::<span class="ident">Method</span> { + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">method</span> + } + + <span class="kw">fn</span> <span class="ident">scheme</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Scheme</span> { + <span class="self">self</span>.<span class="ident">scheme</span>() + } + + <span class="kw">fn</span> <span class="ident">host</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">conduit</span>::<span class="ident">Host</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> { + <span class="ident">conduit</span>::<span class="ident">Host</span>::<span class="ident">Name</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">host</span>) + } + + <span class="kw">fn</span> <span class="ident">virtual_root</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">option</span>::<span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> { + <span class="prelude-val">None</span> + } + + <span class="kw">fn</span> <span class="ident">path</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> { + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">path</span> + } + + <span class="kw">fn</span> <span class="ident">query_string</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">option</span>::<span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> { + <span class="self">self</span>.<span class="ident">query</span>.<span class="ident">as_ref</span>() + .<span class="ident">map</span>(<span class="op">|</span><span class="ident">p</span><span class="op">|</span> <span class="ident">p</span>.<span class="ident">as_str</span>()) + } + + <span class="kw">fn</span> <span class="ident">remote_addr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">net</span>::<span class="ident">SocketAddr</span> { + <span class="self">self</span>.<span class="ident">remote_addr</span> + } + + <span class="kw">fn</span> <span class="ident">content_length</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">option</span>::<span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">u64</span><span class="op">></span> { + <span class="self">self</span>.<span class="ident">content_length</span> + } + + <span class="kw">fn</span> <span class="ident">headers</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">conduit</span>::<span class="ident">HeaderMap</span> { + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">headers</span> + } + + <span class="kw">fn</span> <span class="ident">body</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> (<span class="kw">dyn</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>) { + <span class="self">self</span> + } + + <span class="kw">fn</span> <span class="ident">extensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">conduit</span>::<span class="ident">Extensions</span> { + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">extensions</span> + } + + <span class="kw">fn</span> <span class="ident">mut_extensions</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">conduit</span>::<span class="ident">Extensions</span> { + <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">extensions</span> + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "fastcgi_conduit";</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>
\ No newline at end of file |