216 lines
42 KiB
HTML
216 lines
42 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="API documentation for the Rust `header` mod in crate `actix_http`."><meta name="keywords" content="rust, rustlang, rust-lang, header"><title>actix_http::http::header - Rust</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 mod"><!--[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='../../../actix_http/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module header</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>actix_http</a>::<wbr><a href='../index.html'>http</a></p><script>window.sidebarCurrent = {name: 'header', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></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"><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"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/actix_http/lib.rs.html#61-63' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>actix_http</a>::<wbr><a href='../index.html'>http</a>::<wbr><a class="mod" href=''>header</a></span></h1><div class='docblock'><p>Various http headers</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Accept.html" title='actix_http::http::header::Accept struct'>Accept</a></td><td class='docblock-short'><p><code>Accept</code> header, defined in <a href="http://tools.ietf.org/html/rfc7231#section-5.3.2">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.AcceptCharset.html" title='actix_http::http::header::AcceptCharset struct'>AcceptCharset</a></td><td class='docblock-short'><p><code>Accept-Charset</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7231#section-5.3.3">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.AcceptLanguage.html" title='actix_http::http::header::AcceptLanguage struct'>AcceptLanguage</a></td><td class='docblock-short'><p><code>Accept-Language</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7231#section-5.3.5">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Allow.html" title='actix_http::http::header::Allow struct'>Allow</a></td><td class='docblock-short'><p><code>Allow</code> header, defined in <a href="http://tools.ietf.org/html/rfc7231#section-7.4.1">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CacheControl.html" title='actix_http::http::header::CacheControl struct'>CacheControl</a></td><td class='docblock-short'><p><code>Cache-Control</code> header, defined in <a href="https://tools.ietf.org/html/rfc7234#section-5.2">RFC7234</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ContentDisposition.html" title='actix_http::http::header::ContentDisposition struct'>ContentDisposition</a></td><td class='docblock-short'><p>A <em>Content-Disposition</em> header. It is compatible to be used either as
|
||
<a href="https://mdn.io/Content-Disposition#As_a_response_header_for_the_main_body">a response header for the main body</a>
|
||
as (re)defined in <a href="https://tools.ietf.org/html/rfc6266">RFC6266</a>, or as
|
||
<a href="https://mdn.io/Content-Disposition#As_a_header_for_a_multipart_body">a header for a multipart body</a>
|
||
as (re)defined in <a href="https://tools.ietf.org/html/rfc7578">RFC7587</a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ContentLanguage.html" title='actix_http::http::header::ContentLanguage struct'>ContentLanguage</a></td><td class='docblock-short'><p><code>Content-Language</code> header, defined in
|
||
<a href="https://tools.ietf.org/html/rfc7231#section-3.1.3.2">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ContentRange.html" title='actix_http::http::header::ContentRange struct'>ContentRange</a></td><td class='docblock-short'><p><code>Content-Range</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7233#section-4.2">RFC7233</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ContentType.html" title='actix_http::http::header::ContentType struct'>ContentType</a></td><td class='docblock-short'><p><code>Content-Type</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7231#section-3.1.1.5">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Date.html" title='actix_http::http::header::Date struct'>Date</a></td><td class='docblock-short'><p><code>Date</code> header, defined in <a href="http://tools.ietf.org/html/rfc7231#section-7.1.1.2">RFC7231</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Drain.html" title='actix_http::http::header::Drain struct'>Drain</a></td><td class='docblock-short'><p>A drain iterator for <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ETag.html" title='actix_http::http::header::ETag struct'>ETag</a></td><td class='docblock-short'><p><code>ETag</code> header, defined in <a href="http://tools.ietf.org/html/rfc7232#section-2.3">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Expires.html" title='actix_http::http::header::Expires struct'>Expires</a></td><td class='docblock-short'><p><code>Expires</code> header, defined in <a href="http://tools.ietf.org/html/rfc7234#section-5.3">RFC7234</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ExtendedValue.html" title='actix_http::http::header::ExtendedValue struct'>ExtendedValue</a></td><td class='docblock-short'><p>The value part of an extended parameter consisting of three parts:
|
||
the REQUIRED character set name (<code>charset</code>), the OPTIONAL language information (<code>language_tag</code>),
|
||
and a character sequence representing the actual value (<code>value</code>), separated by single quote
|
||
characters. It is defined in <a href="https://tools.ietf.org/html/rfc5987#section-3.2">RFC 5987</a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.GetAll.html" title='actix_http::http::header::GetAll struct'>GetAll</a></td><td class='docblock-short'><p>A view to all values stored in a single entry.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HeaderMap.html" title='actix_http::http::header::HeaderMap struct'>HeaderMap</a></td><td class='docblock-short'><p>A set of HTTP headers</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HeaderMap.html" title='actix_http::http::header::HeaderMap struct'>HeaderMap</a></td><td class='docblock-short'><p>A set of HTTP headers</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HeaderName.html" title='actix_http::http::header::HeaderName struct'>HeaderName</a></td><td class='docblock-short'><p>Represents an HTTP header field name</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.HeaderValue.html" title='actix_http::http::header::HeaderValue struct'>HeaderValue</a></td><td class='docblock-short'><p>Represents an HTTP header field value.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IfModifiedSince.html" title='actix_http::http::header::IfModifiedSince struct'>IfModifiedSince</a></td><td class='docblock-short'><p><code>If-Modified-Since</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7232#section-3.3">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IfUnmodifiedSince.html" title='actix_http::http::header::IfUnmodifiedSince struct'>IfUnmodifiedSince</a></td><td class='docblock-short'><p><code>If-Unmodified-Since</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7232#section-3.4">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IntoIter.html" title='actix_http::http::header::IntoIter struct'>IntoIter</a></td><td class='docblock-short'><p>An owning iterator over the entries of a <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InvalidHeaderName.html" title='actix_http::http::header::InvalidHeaderName struct'>InvalidHeaderName</a></td><td class='docblock-short'><p>A possible error when converting a <code>HeaderName</code> from another type.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InvalidHeaderNameBytes.html" title='actix_http::http::header::InvalidHeaderNameBytes struct'>InvalidHeaderNameBytes</a></td><td class='docblock-short'><p>A possible error when converting a <code>HeaderName</code> from another type.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InvalidHeaderValue.html" title='actix_http::http::header::InvalidHeaderValue struct'>InvalidHeaderValue</a></td><td class='docblock-short'><p>A possible error when converting a <code>HeaderValue</code> from a string or byte
|
||
slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.InvalidHeaderValueBytes.html" title='actix_http::http::header::InvalidHeaderValueBytes struct'>InvalidHeaderValueBytes</a></td><td class='docblock-short'><p>A possible error when converting a <code>HeaderValue</code> from a string or byte
|
||
slice.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Iter.html" title='actix_http::http::header::Iter struct'>Iter</a></td><td class='docblock-short'><p><code>HeaderMap</code> entry iterator.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IterMut.html" title='actix_http::http::header::IterMut struct'>IterMut</a></td><td class='docblock-short'><p><code>HeaderMap</code> mutable entry iterator</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Keys.html" title='actix_http::http::header::Keys struct'>Keys</a></td><td class='docblock-short'><p>An iterator over <code>HeaderMap</code> keys.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LastModified.html" title='actix_http::http::header::LastModified struct'>LastModified</a></td><td class='docblock-short'><p><code>Last-Modified</code> header, defined in
|
||
<a href="http://tools.ietf.org/html/rfc7232#section-2.2">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.OccupiedEntry.html" title='actix_http::http::header::OccupiedEntry struct'>OccupiedEntry</a></td><td class='docblock-short'><p>A view into a single occupied location in a <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ToStrError.html" title='actix_http::http::header::ToStrError struct'>ToStrError</a></td><td class='docblock-short'><p>A possible error when converting a <code>HeaderValue</code> to a string representation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.VacantEntry.html" title='actix_http::http::header::VacantEntry struct'>VacantEntry</a></td><td class='docblock-short'><p>A view into a single empty location in a <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValueDrain.html" title='actix_http::http::header::ValueDrain struct'>ValueDrain</a></td><td class='docblock-short'><p>An drain iterator of all values associated with a single header name.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValueIter.html" title='actix_http::http::header::ValueIter struct'>ValueIter</a></td><td class='docblock-short'><p>An iterator of all values associated with a single header name.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValueIterMut.html" title='actix_http::http::header::ValueIterMut struct'>ValueIterMut</a></td><td class='docblock-short'><p>A mutable iterator of all values associated with a single header name.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Values.html" title='actix_http::http::header::Values struct'>Values</a></td><td class='docblock-short'><p><code>HeaderMap</code> value iterator.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ValuesMut.html" title='actix_http::http::header::ValuesMut struct'>ValuesMut</a></td><td class='docblock-short'><p><code>HeaderMap</code> mutable value iterator</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.CacheDirective.html" title='actix_http::http::header::CacheDirective enum'>CacheDirective</a></td><td class='docblock-short'><p><code>CacheControl</code> contains a list of these directives.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ContentEncoding.html" title='actix_http::http::header::ContentEncoding enum'>ContentEncoding</a></td><td class='docblock-short'><p>Represents supported types of content encodings</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ContentRangeSpec.html" title='actix_http::http::header::ContentRangeSpec enum'>ContentRangeSpec</a></td><td class='docblock-short'><p>Content-Range, described in <a href="https://tools.ietf.org/html/rfc7233#section-4.2">RFC7233</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.DispositionParam.html" title='actix_http::http::header::DispositionParam enum'>DispositionParam</a></td><td class='docblock-short'><p>Parameter in [<code>ContentDisposition</code>].</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.DispositionType.html" title='actix_http::http::header::DispositionType enum'>DispositionType</a></td><td class='docblock-short'><p>The implied disposition of the content of the HTTP body.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Entry.html" title='actix_http::http::header::Entry enum'>Entry</a></td><td class='docblock-short'><p>A view into a single location in a <code>HeaderMap</code>, which may be vacant or occupied.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.IfMatch.html" title='actix_http::http::header::IfMatch enum'>IfMatch</a></td><td class='docblock-short'><p><code>If-Match</code> header, defined in
|
||
<a href="https://tools.ietf.org/html/rfc7232#section-3.1">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.IfNoneMatch.html" title='actix_http::http::header::IfNoneMatch enum'>IfNoneMatch</a></td><td class='docblock-short'><p><code>If-None-Match</code> header, defined in
|
||
<a href="https://tools.ietf.org/html/rfc7232#section-3.2">RFC7232</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.IfRange.html" title='actix_http::http::header::IfRange enum'>IfRange</a></td><td class='docblock-short'><p><code>If-Range</code> header, defined in <a href="http://tools.ietf.org/html/rfc7233#section-3.2">RFC7233</a></p>
|
||
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
||
<table><tr class='module-item'><td><a class="constant" href="constant.ACCEPT.html" title='actix_http::http::header::ACCEPT constant'>ACCEPT</a></td><td class='docblock-short'><p>Advertises which content types the client is able to understand.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCEPT_CHARSET.html" title='actix_http::http::header::ACCEPT_CHARSET constant'>ACCEPT_CHARSET</a></td><td class='docblock-short'><p>Advertises which character set the client is able to understand.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCEPT_ENCODING.html" title='actix_http::http::header::ACCEPT_ENCODING constant'>ACCEPT_ENCODING</a></td><td class='docblock-short'><p>Advertises which content encoding the client is able to understand.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCEPT_LANGUAGE.html" title='actix_http::http::header::ACCEPT_LANGUAGE constant'>ACCEPT_LANGUAGE</a></td><td class='docblock-short'><p>Advertises which languages the client is able to understand.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCEPT_RANGES.html" title='actix_http::http::header::ACCEPT_RANGES constant'>ACCEPT_RANGES</a></td><td class='docblock-short'><p>Marker used by the server to advertise partial request support.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_ALLOW_CREDENTIALS.html" title='actix_http::http::header::ACCESS_CONTROL_ALLOW_CREDENTIALS constant'>ACCESS_CONTROL_ALLOW_CREDENTIALS</a></td><td class='docblock-short'><p>Preflight response indicating if the response to the request can be
|
||
exposed to the page.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_ALLOW_HEADERS.html" title='actix_http::http::header::ACCESS_CONTROL_ALLOW_HEADERS constant'>ACCESS_CONTROL_ALLOW_HEADERS</a></td><td class='docblock-short'><p>Preflight response indicating permitted HTTP headers.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_ALLOW_METHODS.html" title='actix_http::http::header::ACCESS_CONTROL_ALLOW_METHODS constant'>ACCESS_CONTROL_ALLOW_METHODS</a></td><td class='docblock-short'><p>Preflight header response indicating permitted access methods.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_ALLOW_ORIGIN.html" title='actix_http::http::header::ACCESS_CONTROL_ALLOW_ORIGIN constant'>ACCESS_CONTROL_ALLOW_ORIGIN</a></td><td class='docblock-short'><p>Indicates whether the response can be shared with resources with the
|
||
given origin.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_EXPOSE_HEADERS.html" title='actix_http::http::header::ACCESS_CONTROL_EXPOSE_HEADERS constant'>ACCESS_CONTROL_EXPOSE_HEADERS</a></td><td class='docblock-short'><p>Indicates which headers can be exposed as part of the response by
|
||
listing their names.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_MAX_AGE.html" title='actix_http::http::header::ACCESS_CONTROL_MAX_AGE constant'>ACCESS_CONTROL_MAX_AGE</a></td><td class='docblock-short'><p>Indicates how long the results of a preflight request can be cached.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_REQUEST_HEADERS.html" title='actix_http::http::header::ACCESS_CONTROL_REQUEST_HEADERS constant'>ACCESS_CONTROL_REQUEST_HEADERS</a></td><td class='docblock-short'><p>Informs the server which HTTP headers will be used when an actual
|
||
request is made.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ACCESS_CONTROL_REQUEST_METHOD.html" title='actix_http::http::header::ACCESS_CONTROL_REQUEST_METHOD constant'>ACCESS_CONTROL_REQUEST_METHOD</a></td><td class='docblock-short'><p>Informs the server know which HTTP method will be used when the actual
|
||
request is made.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.AGE.html" title='actix_http::http::header::AGE constant'>AGE</a></td><td class='docblock-short'><p>Indicates the time in seconds the object has been in a proxy cache.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ALLOW.html" title='actix_http::http::header::ALLOW constant'>ALLOW</a></td><td class='docblock-short'><p>Lists the set of methods support by a resource.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ALT_SVC.html" title='actix_http::http::header::ALT_SVC constant'>ALT_SVC</a></td><td class='docblock-short'><p>Advertises the availability of alternate services to clients.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.AUTHORIZATION.html" title='actix_http::http::header::AUTHORIZATION constant'>AUTHORIZATION</a></td><td class='docblock-short'><p>Contains the credentials to authenticate a user agent with a server.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CACHE_CONTROL.html" title='actix_http::http::header::CACHE_CONTROL constant'>CACHE_CONTROL</a></td><td class='docblock-short'><p>Specifies directives for caching mechanisms in both requests and
|
||
responses.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONNECTION.html" title='actix_http::http::header::CONNECTION constant'>CONNECTION</a></td><td class='docblock-short'><p>Controls whether or not the network connection stays open after the
|
||
current transaction finishes.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_DISPOSITION.html" title='actix_http::http::header::CONTENT_DISPOSITION constant'>CONTENT_DISPOSITION</a></td><td class='docblock-short'><p>Indicates if the content is expected to be displayed inline.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_ENCODING.html" title='actix_http::http::header::CONTENT_ENCODING constant'>CONTENT_ENCODING</a></td><td class='docblock-short'><p>Used to compress the media-type.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_LANGUAGE.html" title='actix_http::http::header::CONTENT_LANGUAGE constant'>CONTENT_LANGUAGE</a></td><td class='docblock-short'><p>Used to describe the languages intended for the audience.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_LENGTH.html" title='actix_http::http::header::CONTENT_LENGTH constant'>CONTENT_LENGTH</a></td><td class='docblock-short'><p>Indicates the size fo the entity-body.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_LOCATION.html" title='actix_http::http::header::CONTENT_LOCATION constant'>CONTENT_LOCATION</a></td><td class='docblock-short'><p>Indicates an alternate location for the returned data.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_RANGE.html" title='actix_http::http::header::CONTENT_RANGE constant'>CONTENT_RANGE</a></td><td class='docblock-short'><p>Indicates where in a full body message a partial message belongs.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_SECURITY_POLICY.html" title='actix_http::http::header::CONTENT_SECURITY_POLICY constant'>CONTENT_SECURITY_POLICY</a></td><td class='docblock-short'><p>Allows controlling resources the user agent is allowed to load for a
|
||
given page.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_SECURITY_POLICY_REPORT_ONLY.html" title='actix_http::http::header::CONTENT_SECURITY_POLICY_REPORT_ONLY constant'>CONTENT_SECURITY_POLICY_REPORT_ONLY</a></td><td class='docblock-short'><p>Allows experimenting with policies by monitoring their effects.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.CONTENT_TYPE.html" title='actix_http::http::header::CONTENT_TYPE constant'>CONTENT_TYPE</a></td><td class='docblock-short'><p>Used to indicate the media type of the resource.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.COOKIE.html" title='actix_http::http::header::COOKIE constant'>COOKIE</a></td><td class='docblock-short'><p>Contains stored HTTP cookies previously sent by the server with the
|
||
Set-Cookie header.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.DATE.html" title='actix_http::http::header::DATE constant'>DATE</a></td><td class='docblock-short'><p>Contains the date and time at which the message was originated.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.DNT.html" title='actix_http::http::header::DNT constant'>DNT</a></td><td class='docblock-short'><p>Indicates the client's tracking preference.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ETAG.html" title='actix_http::http::header::ETAG constant'>ETAG</a></td><td class='docblock-short'><p>Identifier for a specific version of a resource.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.EXPECT.html" title='actix_http::http::header::EXPECT constant'>EXPECT</a></td><td class='docblock-short'><p>Indicates expectations that need to be fulfilled by the server in order
|
||
to properly handle the request.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.EXPIRES.html" title='actix_http::http::header::EXPIRES constant'>EXPIRES</a></td><td class='docblock-short'><p>Contains the date/time after which the response is considered stale.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.FORWARDED.html" title='actix_http::http::header::FORWARDED constant'>FORWARDED</a></td><td class='docblock-short'><p>Contains information from the client-facing side of proxy servers that
|
||
is altered or lost when a proxy is involved in the path of the request.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.FROM.html" title='actix_http::http::header::FROM constant'>FROM</a></td><td class='docblock-short'><p>Contains an Internet email address for a human user who controls the
|
||
requesting user agent.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.HOST.html" title='actix_http::http::header::HOST constant'>HOST</a></td><td class='docblock-short'><p>Specifies the domain name of the server and (optionally) the TCP port
|
||
number on which the server is listening.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.IF_MATCH.html" title='actix_http::http::header::IF_MATCH constant'>IF_MATCH</a></td><td class='docblock-short'><p>Makes a request conditional based on the E-Tag.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.IF_MODIFIED_SINCE.html" title='actix_http::http::header::IF_MODIFIED_SINCE constant'>IF_MODIFIED_SINCE</a></td><td class='docblock-short'><p>Makes a request conditional based on the modification date.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.IF_NONE_MATCH.html" title='actix_http::http::header::IF_NONE_MATCH constant'>IF_NONE_MATCH</a></td><td class='docblock-short'><p>Makes a request conditional based on the E-Tag.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.IF_RANGE.html" title='actix_http::http::header::IF_RANGE constant'>IF_RANGE</a></td><td class='docblock-short'><p>Makes a request conditional based on range.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.IF_UNMODIFIED_SINCE.html" title='actix_http::http::header::IF_UNMODIFIED_SINCE constant'>IF_UNMODIFIED_SINCE</a></td><td class='docblock-short'><p>Makes the request conditional based on the last modification date.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.LAST_MODIFIED.html" title='actix_http::http::header::LAST_MODIFIED constant'>LAST_MODIFIED</a></td><td class='docblock-short'><p>Content-Types that are acceptable for the response.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.LINK.html" title='actix_http::http::header::LINK constant'>LINK</a></td><td class='docblock-short'><p>Allows the server to point an interested client to another resource
|
||
containing metadata about the requested resource.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.LOCATION.html" title='actix_http::http::header::LOCATION constant'>LOCATION</a></td><td class='docblock-short'><p>Indicates the URL to redirect a page to.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.MAX_FORWARDS.html" title='actix_http::http::header::MAX_FORWARDS constant'>MAX_FORWARDS</a></td><td class='docblock-short'><p>Indicates the max number of intermediaries the request should be sent
|
||
through.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.ORIGIN.html" title='actix_http::http::header::ORIGIN constant'>ORIGIN</a></td><td class='docblock-short'><p>Indicates where a fetch originates from.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.PRAGMA.html" title='actix_http::http::header::PRAGMA constant'>PRAGMA</a></td><td class='docblock-short'><p>HTTP/1.0 header usually used for backwards compatibility.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.PROXY_AUTHENTICATE.html" title='actix_http::http::header::PROXY_AUTHENTICATE constant'>PROXY_AUTHENTICATE</a></td><td class='docblock-short'><p>Defines the authentication method that should be used to gain access to
|
||
a proxy.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.PROXY_AUTHORIZATION.html" title='actix_http::http::header::PROXY_AUTHORIZATION constant'>PROXY_AUTHORIZATION</a></td><td class='docblock-short'><p>Contains the credentials to authenticate a user agent to a proxy server.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.PUBLIC_KEY_PINS.html" title='actix_http::http::header::PUBLIC_KEY_PINS constant'>PUBLIC_KEY_PINS</a></td><td class='docblock-short'><p>Associates a specific cryptographic public key with a certain server.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.PUBLIC_KEY_PINS_REPORT_ONLY.html" title='actix_http::http::header::PUBLIC_KEY_PINS_REPORT_ONLY constant'>PUBLIC_KEY_PINS_REPORT_ONLY</a></td><td class='docblock-short'><p>Sends reports of pinning violation to the report-uri specified in the
|
||
header.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.RANGE.html" title='actix_http::http::header::RANGE constant'>RANGE</a></td><td class='docblock-short'><p>Indicates the part of a document that the server should return.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REFERER.html" title='actix_http::http::header::REFERER constant'>REFERER</a></td><td class='docblock-short'><p>Contains the address of the previous web page from which a link to the
|
||
currently requested page was followed.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REFERRER_POLICY.html" title='actix_http::http::header::REFERRER_POLICY constant'>REFERRER_POLICY</a></td><td class='docblock-short'><p>Governs which referrer information should be included with requests
|
||
made.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REFRESH.html" title='actix_http::http::header::REFRESH constant'>REFRESH</a></td><td class='docblock-short'><p>Informs the web browser that the current page or frame should be
|
||
refreshed.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.RETRY_AFTER.html" title='actix_http::http::header::RETRY_AFTER constant'>RETRY_AFTER</a></td><td class='docblock-short'><p>The Retry-After response HTTP header indicates how long the user agent
|
||
should wait before making a follow-up request. There are two main cases
|
||
this header is used:</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SEC_WEBSOCKET_ACCEPT.html" title='actix_http::http::header::SEC_WEBSOCKET_ACCEPT constant'>SEC_WEBSOCKET_ACCEPT</a></td><td class='docblock-short'><p>The |Sec-WebSocket-Accept| header field is used in the WebSocket
|
||
opening handshake. It is sent from the server to the client to
|
||
confirm that the server is willing to initiate the WebSocket
|
||
connection.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SEC_WEBSOCKET_EXTENSIONS.html" title='actix_http::http::header::SEC_WEBSOCKET_EXTENSIONS constant'>SEC_WEBSOCKET_EXTENSIONS</a></td><td class='docblock-short'><p>The |Sec-WebSocket-Extensions| header field is used in the WebSocket
|
||
opening handshake. It is initially sent from the client to the
|
||
server, and then subsequently sent from the server to the client, to
|
||
agree on a set of protocol-level extensions to use for the duration
|
||
of the connection.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SEC_WEBSOCKET_KEY.html" title='actix_http::http::header::SEC_WEBSOCKET_KEY constant'>SEC_WEBSOCKET_KEY</a></td><td class='docblock-short'><p>The |Sec-WebSocket-Key| header field is used in the WebSocket opening
|
||
handshake. It is sent from the client to the server to provide part
|
||
of the information used by the server to prove that it received a
|
||
valid WebSocket opening handshake. This helps ensure that the server
|
||
does not accept connections from non-WebSocket clients (e.g., HTTP
|
||
clients) that are being abused to send data to unsuspecting WebSocket
|
||
servers.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SEC_WEBSOCKET_PROTOCOL.html" title='actix_http::http::header::SEC_WEBSOCKET_PROTOCOL constant'>SEC_WEBSOCKET_PROTOCOL</a></td><td class='docblock-short'><p>The |Sec-WebSocket-Protocol| header field is used in the WebSocket
|
||
opening handshake. It is sent from the client to the server and back
|
||
from the server to the client to confirm the subprotocol of the
|
||
connection. This enables scripts to both select a subprotocol and be
|
||
sure that the server agreed to serve that subprotocol.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SEC_WEBSOCKET_VERSION.html" title='actix_http::http::header::SEC_WEBSOCKET_VERSION constant'>SEC_WEBSOCKET_VERSION</a></td><td class='docblock-short'><p>The |Sec-WebSocket-Version| header field is used in the WebSocket
|
||
opening handshake. It is sent from the client to the server to
|
||
indicate the protocol version of the connection. This enables
|
||
servers to correctly interpret the opening handshake and subsequent
|
||
data being sent from the data, and close the connection if the server
|
||
cannot interpret that data in a safe manner.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SERVER.html" title='actix_http::http::header::SERVER constant'>SERVER</a></td><td class='docblock-short'><p>Contains information about the software used by the origin server to
|
||
handle the request.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.SET_COOKIE.html" title='actix_http::http::header::SET_COOKIE constant'>SET_COOKIE</a></td><td class='docblock-short'><p>Used to send cookies from the server to the user agent.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.STRICT_TRANSPORT_SECURITY.html" title='actix_http::http::header::STRICT_TRANSPORT_SECURITY constant'>STRICT_TRANSPORT_SECURITY</a></td><td class='docblock-short'><p>Tells the client to communicate with HTTPS instead of using HTTP.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.TE.html" title='actix_http::http::header::TE constant'>TE</a></td><td class='docblock-short'><p>Informs the server of transfer encodings willing to be accepted as part
|
||
of the response.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.TRAILER.html" title='actix_http::http::header::TRAILER constant'>TRAILER</a></td><td class='docblock-short'><p>Allows the sender to include additional fields at the end of chunked
|
||
messages.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.TRANSFER_ENCODING.html" title='actix_http::http::header::TRANSFER_ENCODING constant'>TRANSFER_ENCODING</a></td><td class='docblock-short'><p>Specifies the form of encoding used to safely transfer the entity to the
|
||
client.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.UPGRADE.html" title='actix_http::http::header::UPGRADE constant'>UPGRADE</a></td><td class='docblock-short'><p>Used as part of the exchange to upgrade the protocol.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.UPGRADE_INSECURE_REQUESTS.html" title='actix_http::http::header::UPGRADE_INSECURE_REQUESTS constant'>UPGRADE_INSECURE_REQUESTS</a></td><td class='docblock-short'><p>Sends a signal to the server expressing the client’s preference for an
|
||
encrypted and authenticated response.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.USER_AGENT.html" title='actix_http::http::header::USER_AGENT constant'>USER_AGENT</a></td><td class='docblock-short'><p>Contains a string that allows identifying the requesting client's
|
||
software.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.VARY.html" title='actix_http::http::header::VARY constant'>VARY</a></td><td class='docblock-short'><p>Determines how to match future requests with cached responses.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.VIA.html" title='actix_http::http::header::VIA constant'>VIA</a></td><td class='docblock-short'><p>Added by proxies to track routing.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.WARNING.html" title='actix_http::http::header::WARNING constant'>WARNING</a></td><td class='docblock-short'><p>General HTTP header contains information about possible problems with
|
||
the status of the message.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.WWW_AUTHENTICATE.html" title='actix_http::http::header::WWW_AUTHENTICATE constant'>WWW_AUTHENTICATE</a></td><td class='docblock-short'><p>Defines the authentication method that should be used to gain access to
|
||
a resource.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.X_CONTENT_TYPE_OPTIONS.html" title='actix_http::http::header::X_CONTENT_TYPE_OPTIONS constant'>X_CONTENT_TYPE_OPTIONS</a></td><td class='docblock-short'><p>Marker used by the server to indicate that the MIME types advertised in
|
||
the <code>content-type</code> headers should not be changed and be followed.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.X_DNS_PREFETCH_CONTROL.html" title='actix_http::http::header::X_DNS_PREFETCH_CONTROL constant'>X_DNS_PREFETCH_CONTROL</a></td><td class='docblock-short'><p>Controls DNS prefetching.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.X_FRAME_OPTIONS.html" title='actix_http::http::header::X_FRAME_OPTIONS constant'>X_FRAME_OPTIONS</a></td><td class='docblock-short'><p>Indicates whether or not a browser should be allowed to render a page in
|
||
a frame.</p>
|
||
</td></tr><tr class='module-item'><td><a class="constant" href="constant.X_XSS_PROTECTION.html" title='actix_http::http::header::X_XSS_PROTECTION constant'>X_XSS_PROTECTION</a></td><td class='docblock-short'><p>Stop pages from loading when an XSS attack is detected.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.AsHeaderName.html" title='actix_http::http::header::AsHeaderName trait'>AsHeaderName</a></td><td class='docblock-short'><p>A marker trait used to identify values that can be used as search keys
|
||
to a <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Header.html" title='actix_http::http::header::Header trait'>Header</a></td><td class='docblock-short'><p>A trait for any object that will represent a header field and value.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.IntoHeaderName.html" title='actix_http::http::header::IntoHeaderName trait'>IntoHeaderName</a></td><td class='docblock-short'><p>A marker trait used to identify values that can be used as insert keys
|
||
to a <code>HeaderMap</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.IntoHeaderValue.html" title='actix_http::http::header::IntoHeaderValue trait'>IntoHeaderValue</a></td><td class='docblock-short'><p>A trait for any object that can be Converted to a <code>HeaderValue</code></p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.http_percent_encode.html" title='actix_http::http::header::http_percent_encode fn'>http_percent_encode</a></td><td class='docblock-short'><p>Percent encode a sequence of bytes with a character set defined in
|
||
<a href="https://tools.ietf.org/html/rfc5987#section-3.2">https://tools.ietf.org/html/rfc5987#section-3.2</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.parse_extended_value.html" title='actix_http::http::header::parse_extended_value fn'>parse_extended_value</a></td><td class='docblock-short'><p>Parses extended header parameter values (<code>ext-value</code>), as defined in
|
||
<a href="https://tools.ietf.org/html/rfc5987#section-3.2">RFC 5987</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "actix_http";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |