1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-23 16:21:06 +01:00
actix-web/actix_http/index.html
2024-05-27 01:16:31 +00:00

14 lines
12 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="HTTP types and services for the Actix ecosystem."><title>actix_http - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_http" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_http/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_http/index.html">actix_http</a><span class="version">3.7.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">actix_http</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/actix_http/lib.rs.html#1-116">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HTTP types and services for the Actix ecosystem.</p>
<h3 id="crate-features"><a class="doc-anchor" href="#crate-features">§</a>Crate Features</h3><div><table><thead><tr><th>Feature</th><th>Functionality</th></tr></thead><tbody>
<tr><td><code>http2</code></td><td>HTTP/2 support via <a href="https://crates.io/crates/h2">h2</a>.</td></tr>
<tr><td><code>openssl</code></td><td>TLS support via <a href="https://crates.io/crates/openssl">OpenSSL</a>.</td></tr>
<tr><td><code>rustls</code></td><td>TLS support via <a href="https://crates.io/crates/rustls">rustls</a> 0.20.</td></tr>
<tr><td><code>rustls-0_21</code></td><td>TLS support via <a href="https://crates.io/crates/rustls">rustls</a> 0.21.</td></tr>
<tr><td><code>rustls-0_22</code></td><td>TLS support via <a href="https://crates.io/crates/rustls">rustls</a> 0.22.</td></tr>
<tr><td><code>rustls-0_23</code></td><td>TLS support via <a href="https://crates.io/crates/rustls">rustls</a> 0.23.</td></tr>
<tr><td><code>compress-brotli</code></td><td>Payload compression support: Brotli.</td></tr>
<tr><td><code>compress-gzip</code></td><td>Payload compression support: Deflate, Gzip.</td></tr>
<tr><td><code>compress-zstd</code></td><td>Payload compression support: Zstd.</td></tr>
<tr><td><code>trust-dns</code></td><td>Use <a href="https://crates.io/crates/trust-dns">trust-dns</a> as the client DNS resolver.</td></tr>
</tbody></table>
</div></div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.PayloadStream"><code>pub use self::payload::PayloadStream;</code></div><div class="desc docblock-short"><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name" id="reexport.Error"><code>pub use self::error::<a class="struct" href="error/struct.Error.html" title="struct actix_http::error::Error">Error</a>;</code></div></li><li><div class="item-name" id="reexport.ContentEncoding"><code>pub use self::header::<a class="enum" href="header/enum.ContentEncoding.html" title="enum actix_http::header::ContentEncoding">ContentEncoding</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="body/index.html" title="mod actix_http::body">body</a></div><div class="desc docblock-short">Traits and structures to aid consuming and writing HTTP payloads.</div></li><li><div class="item-name"><a class="mod" href="encoding/index.html" title="mod actix_http::encoding">encoding</a><span class="stab portability" title="Available on crate feature `__compress` only"><code>__compress</code></span></div><div class="desc docblock-short">Content-Encoding support.</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod actix_http::error">error</a></div><div class="desc docblock-short">Error and Result module</div></li><li><div class="item-name"><a class="mod" href="h1/index.html" title="mod actix_http::h1">h1</a></div><div class="desc docblock-short">HTTP/1 protocol implementation.</div></li><li><div class="item-name"><a class="mod" href="h2/index.html" title="mod actix_http::h2">h2</a><span class="stab portability" title="Available on crate feature `http2` only"><code>http2</code></span></div><div class="desc docblock-short">HTTP/2 protocol.</div></li><li><div class="item-name"><a class="mod" href="header/index.html" title="mod actix_http::header">header</a></div><div class="desc docblock-short">Pre-defined <code>HeaderName</code>s, traits for parsing and conversion, and other header utility methods.</div></li><li><div class="item-name"><a class="mod" href="test/index.html" title="mod actix_http::test">test</a></div><div class="desc docblock-short">Various testing helpers for use in internal and app tests.</div></li><li><div class="item-name"><a class="mod" href="uri/index.html" title="mod actix_http::uri">uri</a></div><div class="desc docblock-short">URI component of request and response lines</div></li><li><div class="item-name"><a class="mod" href="ws/index.html" title="mod actix_http::ws">ws</a><span class="stab portability" title="Available on crate feature `ws` only"><code>ws</code></span></div><div class="desc docblock-short">WebSocket protocol implementation.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a></div><div class="desc docblock-short">A type map for request extensions.</div></li><li><div class="item-name"><a class="struct" href="struct.HttpService.html" title="struct actix_http::HttpService">HttpService</a></div><div class="desc docblock-short">A [<code>ServiceFactory</code>] for HTTP/1.1 and HTTP/2 connections.</div></li><li><div class="item-name"><a class="struct" href="struct.HttpServiceBuilder.html" title="struct actix_http::HttpServiceBuilder">HttpServiceBuilder</a></div><div class="desc docblock-short">An HTTP service builder.</div></li><li><div class="item-name"><a class="struct" href="struct.Message.html" title="struct actix_http::Message">Message</a></div></li><li><div class="item-name"><a class="struct" href="struct.Method.html" title="struct actix_http::Method">Method</a></div><div class="desc docblock-short">The Request Method (VERB)</div></li><li><div class="item-name"><a class="struct" href="struct.Request.html" title="struct actix_http::Request">Request</a></div><div class="desc docblock-short">An HTTP request.</div></li><li><div class="item-name"><a class="struct" href="struct.RequestHead.html" title="struct actix_http::RequestHead">RequestHead</a></div></li><li><div class="item-name"><a class="struct" href="struct.Response.html" title="struct actix_http::Response">Response</a></div><div class="desc docblock-short">An HTTP response.</div></li><li><div class="item-name"><a class="struct" href="struct.ResponseBuilder.html" title="struct actix_http::ResponseBuilder">ResponseBuilder</a></div><div class="desc docblock-short">An HTTP response builder.</div></li><li><div class="item-name"><a class="struct" href="struct.ResponseHead.html" title="struct actix_http::ResponseHead">ResponseHead</a></div></li><li><div class="item-name"><a class="struct" href="struct.ServiceConfig.html" title="struct actix_http::ServiceConfig">ServiceConfig</a></div><div class="desc docblock-short">HTTP service configuration.</div></li><li><div class="item-name"><a class="struct" href="struct.StatusCode.html" title="struct actix_http::StatusCode">StatusCode</a></div><div class="desc docblock-short">An HTTP status code (<code>status-code</code> in RFC 7230 et al.).</div></li><li><div class="item-name"><a class="struct" href="struct.TlsAcceptorConfig.html" title="struct actix_http::TlsAcceptorConfig">TlsAcceptorConfig</a><span class="stab portability" title="Available on crate features `openssl` or `rustls-0_20` or `rustls-0_21` or `rustls-0_22` or `rustls-0_23` only"><code>openssl</code> or <code>rustls-0_20</code> or <code>rustls-0_21</code> or <code>rustls-0_22</code> or <code>rustls-0_23</code></span></div><div class="desc docblock-short">Configuration options used when accepting TLS connection.</div></li><li><div class="item-name"><a class="struct" href="struct.Uri.html" title="struct actix_http::Uri">Uri</a></div><div class="desc docblock-short">The URI component of a request.</div></li><li><div class="item-name"><a class="struct" href="struct.Version.html" title="struct actix_http::Version">Version</a></div><div class="desc docblock-short">Represents a version of the HTTP spec.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ConnectionType.html" title="enum actix_http::ConnectionType">ConnectionType</a></div><div class="desc docblock-short">Represents various types of connection</div></li><li><div class="item-name"><a class="enum" href="enum.KeepAlive.html" title="enum actix_http::KeepAlive">KeepAlive</a></div><div class="desc docblock-short">Connection keep-alive config.</div></li><li><div class="item-name"><a class="enum" href="enum.Payload.html" title="enum actix_http::Payload">Payload</a></div><div class="desc docblock-short">A streaming payload.</div></li><li><div class="item-name"><a class="enum" href="enum.Protocol.html" title="enum actix_http::Protocol">Protocol</a></div><div class="desc docblock-short">A major HTTP protocol version.</div></li><li><div class="item-name"><a class="enum" href="enum.RequestHeadType.html" title="enum actix_http::RequestHeadType">RequestHeadType</a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.HttpMessage.html" title="trait actix_http::HttpMessage">HttpMessage</a></div><div class="desc docblock-short">Trait that implements general purpose operations on HTTP messages.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxedPayloadStream.html" title="type actix_http::BoxedPayloadStream">BoxedPayloadStream</a></div><div class="desc docblock-short">A boxed payload stream.</div></li></ul></section></div></main></body></html>