mirror of
https://github.com/actix/actix-website
synced 2025-02-23 20:53:01 +01:00
591 lines
37 KiB
HTML
591 lines
37 KiB
HTML
<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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></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></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 js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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>
|
||
</pre><pre class="rust ">
|
||
<span class="doccomment">//! Actix web is a small, pragmatic, and extremely fast web framework</span>
|
||
<span class="doccomment">//! for Rust.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ```rust</span>
|
||
<span class="doccomment">//! use actix_web::{server, App, Path, Responder};</span>
|
||
<span class="doccomment">//! # use std::thread;</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! fn index(info: Path<(String, u32)>) -> impl Responder {</span>
|
||
<span class="doccomment">//! format!("Hello {}! id:{}", info.0, info.1)</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! fn main() {</span>
|
||
<span class="doccomment">//! # thread::spawn(|| {</span>
|
||
<span class="doccomment">//! server::new(|| {</span>
|
||
<span class="doccomment">//! App::new().resource("/{name}/{id}/index.html", |r| r.with(index))</span>
|
||
<span class="doccomment">//! }).bind("127.0.0.1:8080")</span>
|
||
<span class="doccomment">//! .unwrap()</span>
|
||
<span class="doccomment">//! .run();</span>
|
||
<span class="doccomment">//! # });</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//! ```</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Documentation & community resources</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! Besides the API documentation (which you are currently looking</span>
|
||
<span class="doccomment">//! at!), several other resources are available:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * [User Guide](https://actix.rs/docs/)</span>
|
||
<span class="doccomment">//! * [Chat on gitter](https://gitter.im/actix/actix)</span>
|
||
<span class="doccomment">//! * [GitHub repository](https://github.com/actix/actix-web)</span>
|
||
<span class="doccomment">//! * [Cargo package](https://crates.io/crates/actix-web)</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! To get started navigating the API documentation you may want to</span>
|
||
<span class="doccomment">//! consider looking at the following pages:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * [App](struct.App.html): This struct represents an actix-web</span>
|
||
<span class="doccomment">//! application and is used to configure routes and other common</span>
|
||
<span class="doccomment">//! settings.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * [HttpServer](server/struct.HttpServer.html): This struct</span>
|
||
<span class="doccomment">//! represents an HTTP server instance and is used to instantiate and</span>
|
||
<span class="doccomment">//! configure servers.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * [HttpRequest](struct.HttpRequest.html) and</span>
|
||
<span class="doccomment">//! [HttpResponse](struct.HttpResponse.html): These structs</span>
|
||
<span class="doccomment">//! represent HTTP requests and responses and expose various methods</span>
|
||
<span class="doccomment">//! for inspecting, creating and otherwise utilizing them.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Features</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * Supported *HTTP/1.x* and *HTTP/2.0* protocols</span>
|
||
<span class="doccomment">//! * Streaming and pipelining</span>
|
||
<span class="doccomment">//! * Keep-alive and slow requests handling</span>
|
||
<span class="doccomment">//! * `WebSockets` server/client</span>
|
||
<span class="doccomment">//! * Transparent content compression/decompression (br, gzip, deflate)</span>
|
||
<span class="doccomment">//! * Configurable request routing</span>
|
||
<span class="doccomment">//! * Graceful server shutdown</span>
|
||
<span class="doccomment">//! * Multipart streams</span>
|
||
<span class="doccomment">//! * SSL support with OpenSSL or `native-tls`</span>
|
||
<span class="doccomment">//! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`)</span>
|
||
<span class="doccomment">//! * Built on top of [Actix actor framework](https://github.com/actix/actix)</span>
|
||
<span class="doccomment">//! * Supported Rust version: 1.26 or later</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Package feature</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! * `tls` - enables ssl support via `native-tls` crate</span>
|
||
<span class="doccomment">//! * `ssl` - enables ssl support via `openssl` crate, supports `http/2`</span>
|
||
<span class="doccomment">//! * `rust-tls` - enables ssl support via `rustls` crate, supports `http/2`</span>
|
||
<span class="doccomment">//! * `uds` - enables support for making client requests via Unix Domain Sockets.</span>
|
||
<span class="doccomment">//! Unix only. Not necessary for *serving* requests.</span>
|
||
<span class="doccomment">//! * `session` - enables session support, includes `ring` crate as</span>
|
||
<span class="doccomment">//! dependency</span>
|
||
<span class="doccomment">//! * `brotli` - enables `brotli` compression support, requires `c`</span>
|
||
<span class="doccomment">//! compiler</span>
|
||
<span class="doccomment">//! * `flate2-c` - enables `gzip`, `deflate` compression support, requires</span>
|
||
<span class="doccomment">//! `c` compiler</span>
|
||
<span class="doccomment">//! * `flate2-rust` - experimental rust based implementation for</span>
|
||
<span class="doccomment">//! `gzip`, `deflate` compression.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">actix_nightly</span>, <span class="ident">feature</span>(
|
||
<span class="ident">specialization</span>, <span class="comment">// for impl ErrorResponse for std::error::Error</span>
|
||
<span class="ident">extern_prelude</span>,
|
||
<span class="ident">tool_lints</span>,
|
||
))]</span>
|
||
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span>
|
||
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">log</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">base64</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">byteorder</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">bytes</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">regex</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">sha1</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">time</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">bitflags</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">failure</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lazy_static</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">futures</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">cookie</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">futures_cpupool</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">htmlescape</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">http</span> <span class="kw">as</span> <span class="ident">modhttp</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">httparse</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">language_tags</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lazycell</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mime</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mime_guess</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mio</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">net2</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">parking_lot</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rand</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">slab</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_current_thread</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_io</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_reactor</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_tcp</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_timer</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"uds"</span>))]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_uds</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">url</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"brotli"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">brotli2</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">encoding</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"flate2"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">flate2</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">h2</span> <span class="kw">as</span> <span class="ident">http2</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_cpus</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_urlencoded</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">percent_encoding</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_json</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">smallvec</span>;
|
||
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix_net</span>;
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix</span> <span class="kw">as</span> <span class="ident">actix_inner</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_derive</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">native_tls</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_tls</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"openssl"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">openssl</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"openssl"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_openssl</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustls</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">tokio_rustls</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">webpki</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">webpki_roots</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">application</span>;
|
||
<span class="kw">mod</span> <span class="ident">body</span>;
|
||
<span class="kw">mod</span> <span class="ident">context</span>;
|
||
<span class="kw">mod</span> <span class="ident">de</span>;
|
||
<span class="kw">mod</span> <span class="ident">extensions</span>;
|
||
<span class="kw">mod</span> <span class="ident">extractor</span>;
|
||
<span class="kw">mod</span> <span class="ident">handler</span>;
|
||
<span class="kw">mod</span> <span class="ident">header</span>;
|
||
<span class="kw">mod</span> <span class="ident">helpers</span>;
|
||
<span class="kw">mod</span> <span class="ident">httpcodes</span>;
|
||
<span class="kw">mod</span> <span class="ident">httpmessage</span>;
|
||
<span class="kw">mod</span> <span class="ident">httprequest</span>;
|
||
<span class="kw">mod</span> <span class="ident">httpresponse</span>;
|
||
<span class="kw">mod</span> <span class="ident">info</span>;
|
||
<span class="kw">mod</span> <span class="ident">json</span>;
|
||
<span class="kw">mod</span> <span class="ident">param</span>;
|
||
<span class="kw">mod</span> <span class="ident">payload</span>;
|
||
<span class="kw">mod</span> <span class="ident">pipeline</span>;
|
||
<span class="kw">mod</span> <span class="ident">resource</span>;
|
||
<span class="kw">mod</span> <span class="ident">route</span>;
|
||
<span class="kw">mod</span> <span class="ident">router</span>;
|
||
<span class="kw">mod</span> <span class="ident">scope</span>;
|
||
<span class="kw">mod</span> <span class="ident">uri</span>;
|
||
<span class="kw">mod</span> <span class="ident">with</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">client</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">error</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">fs</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">middleware</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">multipart</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">pred</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">server</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">test</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">ws</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">application</span>::<span class="ident">App</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">body</span>::{<span class="ident">Binary</span>, <span class="ident">Body</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">context</span>::<span class="ident">HttpContext</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">Error</span>, <span class="ident">ResponseError</span>, <span class="prelude-ty">Result</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">extensions</span>::<span class="ident">Extensions</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">extractor</span>::{<span class="ident">Form</span>, <span class="ident">Path</span>, <span class="ident">Query</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">handler</span>::{
|
||
<span class="ident">AsyncResponder</span>, <span class="ident">Either</span>, <span class="ident">FromRequest</span>, <span class="ident">FutureResponse</span>, <span class="ident">Responder</span>, <span class="ident">State</span>,
|
||
};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httpmessage</span>::<span class="ident">HttpMessage</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httprequest</span>::<span class="ident">HttpRequest</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httpresponse</span>::<span class="ident">HttpResponse</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">json</span>::<span class="ident">Json</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">scope</span>::<span class="ident">Scope</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">server</span>::<span class="ident">Request</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">actix</span> {
|
||
<span class="doccomment">//! Re-exports [actix's](https://docs.rs/actix/) prelude</span>
|
||
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">actix</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::<span class="ident">actors</span>::<span class="ident">resolver</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::<span class="ident">actors</span>::<span class="ident">signal</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::<span class="ident">fut</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::<span class="ident">msgs</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">actix</span>::{<span class="ident">run</span>, <span class="ident">spawn</span>};
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"openssl"</span>)]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_OPENSSL</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">true</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"openssl"</span>))]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_OPENSSL</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">false</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"tls"</span>)]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_TLS</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">true</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"tls"</span>))]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_TLS</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">false</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>)]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_RUSTLS</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">true</span>;
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust-tls"</span>))]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">HAS_RUSTLS</span>: <span class="ident">bool</span> <span class="op">=</span> <span class="bool-val">false</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">dev</span> {
|
||
<span class="doccomment">//! The `actix-web` prelude for library developers</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! The purpose of this module is to alleviate imports of many common actix</span>
|
||
<span class="doccomment">//! traits by adding a glob import to the top of actix heavy modules:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ```</span>
|
||
<span class="doccomment">//! # #![allow(unused_imports)]</span>
|
||
<span class="doccomment">//! use actix_web::dev::*;</span>
|
||
<span class="doccomment">//! ```</span>
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">body</span>::<span class="ident">BodyStream</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">context</span>::<span class="ident">Drain</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">extractor</span>::{<span class="ident">FormConfig</span>, <span class="ident">PayloadConfig</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">handler</span>::{<span class="ident">AsyncResult</span>, <span class="ident">Handler</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httpmessage</span>::{<span class="ident">MessageBody</span>, <span class="ident">Readlines</span>, <span class="ident">UrlEncoded</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httpresponse</span>::<span class="ident">HttpResponseBuilder</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">info</span>::<span class="ident">ConnectionInfo</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">json</span>::{<span class="ident">JsonBody</span>, <span class="ident">JsonConfig</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">param</span>::{<span class="ident">FromParam</span>, <span class="ident">Params</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">payload</span>::{<span class="ident">Payload</span>, <span class="ident">PayloadBuffer</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">pipeline</span>::<span class="ident">Pipeline</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">resource</span>::<span class="ident">Resource</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">route</span>::<span class="ident">Route</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">router</span>::{<span class="ident">ResourceDef</span>, <span class="ident">ResourceInfo</span>, <span class="ident">ResourceType</span>, <span class="ident">Router</span>};
|
||
}
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">http</span> {
|
||
<span class="doccomment">//! Various HTTP related types</span>
|
||
|
||
<span class="comment">// re-exports</span>
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">modhttp</span>::{<span class="ident">Method</span>, <span class="ident">StatusCode</span>, <span class="ident">Version</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">modhttp</span>::{<span class="ident">uri</span>, <span class="ident">Error</span>, <span class="ident">Extensions</span>, <span class="ident">HeaderMap</span>, <span class="ident">HttpTryFrom</span>, <span class="ident">Uri</span>};
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">cookie</span>::{<span class="ident">Cookie</span>, <span class="ident">CookieBuilder</span>};
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">helpers</span>::<span class="ident">NormalizePath</span>;
|
||
|
||
<span class="doccomment">/// Various http headers</span>
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">header</span> {
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">header</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">header</span>::{
|
||
<span class="ident">Charset</span>, <span class="ident">ContentDisposition</span>, <span class="ident">DispositionParam</span>, <span class="ident">DispositionType</span>, <span class="ident">LanguageTag</span>,
|
||
};
|
||
}
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">header</span>::<span class="ident">ContentEncoding</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">httpresponse</span>::<span class="ident">ConnectionType</span>;
|
||
}
|
||
</pre>
|
||
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |