actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-07-01 09:05:10 +02:00
Code Issues Releases Wiki Activity

update actix-web api docs

Browse Source
This commit is contained in:
Nikolay Kim
2018-10-10 08:38:33 -07:00
parent 29977f4930
commit bf8faa455d
2298 changed files with 129471 additions and 17241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
static/api/actix-web/stable/src/actix_web/lib.rs.html
View File

@ -271,6 +271,27 @@
<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>
@ -338,8 +359,10 @@
<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">//! * `alpn` - enables ssl support via `openssl` crate, require for `http/2`</span>
<span class="doccomment">//! support</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>
@ -352,11 +375,8 @@
<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">cfg_attr</span>(
<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;cargo-clippy&quot;</span>,
<span class="ident">allow</span>(<span class="ident">decimal_literal_representation</span>, <span class="ident">suspicious_arithmetic_impl</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>
@ -390,10 +410,13 @@
<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">&quot;uds&quot;</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>;
@ -404,10 +427,13 @@
<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>;
@ -425,6 +451,15 @@
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;openssl&quot;</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">&quot;rust-tls&quot;</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">&quot;rust-tls&quot;</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">&quot;rust-tls&quot;</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">&quot;rust-tls&quot;</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>;
@ -447,7 +482,6 @@
<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">serde_urlencoded</span>;
<span class="kw">mod</span> <span class="ident">uri</span>;
<span class="kw">mod</span> <span class="ident">with</span>;
@ -498,6 +532,11 @@
<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">&quot;tls&quot;</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">&quot;rust-tls&quot;</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">&quot;rust-tls&quot;</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>
@ -513,12 +552,13 @@
<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">UrlEncoded</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>};
@ -540,7 +580,9 @@
<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">ContentDisposition</span>, <span class="ident">DispositionType</span>, <span class="ident">DispositionParam</span>, <span class="ident">Charset</span>, <span class="ident">LanguageTag</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>;