1
0
mirror of https://github.com/actix/actix-website synced 2024-11-28 02:22:57 +01:00
actix-website/static/api/actix-web/0.7.0/actix_web/http/header/index.html
2018-07-21 04:09:47 -07:00

948 lines
57 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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_web`."><meta name="keywords" content="rust, rustlang, rust-lang, header"><title>actix_web::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></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">&#9776;</div><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_web</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 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"><h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a class="mod" href=''>header</a></span><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/actix_web/lib.rs.html#267-270' title='goto source code'>[src]</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.ContentDisposition.html"
title='struct actix_web::http::header::ContentDisposition'>ContentDisposition</a></td>
<td class='docblock-short'>
<p>A <code>Content-Disposition</code> header, (re)defined in <a href="https://tools.ietf.org/html/rfc6266">RFC6266</a>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Drain.html"
title='struct actix_web::http::header::Drain'>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.ExtendedValue.html"
title='struct actix_web::http::header::ExtendedValue'>ExtendedValue</a></td>
<td class='docblock-short'>
<p>An extended header parameter value (i.e., tagged with a character set and optionally,
a language), as 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='struct actix_web::http::header::GetAll'>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='struct actix_web::http::header::HeaderMap'>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='struct actix_web::http::header::HeaderName'>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='struct actix_web::http::header::HeaderValue'>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.IntoIter.html"
title='struct actix_web::http::header::IntoIter'>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='struct actix_web::http::header::InvalidHeaderName'>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='struct actix_web::http::header::InvalidHeaderNameBytes'>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='struct actix_web::http::header::InvalidHeaderValue'>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='struct actix_web::http::header::InvalidHeaderValueBytes'>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='struct actix_web::http::header::Iter'>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.Keys.html"
title='struct actix_web::http::header::Keys'>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.LanguageTag.html"
title='struct actix_web::http::header::LanguageTag'>LanguageTag</a></td>
<td class='docblock-short'>
<p>A language tag as described in <a href="http://tools.ietf.org/html/bcp47">BCP47</a>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.OccupiedEntry.html"
title='struct actix_web::http::header::OccupiedEntry'>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='struct actix_web::http::header::ToStrError'>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='struct actix_web::http::header::VacantEntry'>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='struct actix_web::http::header::ValueDrain'>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='struct actix_web::http::header::ValueIter'>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='struct actix_web::http::header::ValueIterMut'>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='struct actix_web::http::header::Values'>Values</a></td>
<td class='docblock-short'>
<p><code>HeaderMap</code> 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.Charset.html"
title='enum actix_web::http::header::Charset'>Charset</a></td>
<td class='docblock-short'>
<p>A Mime charset.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ContentEncoding.html"
title='enum actix_web::http::header::ContentEncoding'>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.DispositionParam.html"
title='enum actix_web::http::header::DispositionParam'>DispositionParam</a></td>
<td class='docblock-short'>
<p>A parameter to the disposition type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DispositionType.html"
title='enum actix_web::http::header::DispositionType'>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='enum actix_web::http::header::Entry'>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></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='constant actix_web::http::header::ACCEPT'>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='constant actix_web::http::header::ACCEPT_CHARSET'>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='constant actix_web::http::header::ACCEPT_ENCODING'>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='constant actix_web::http::header::ACCEPT_LANGUAGE'>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='constant actix_web::http::header::ACCEPT_RANGES'>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='constant actix_web::http::header::ACCESS_CONTROL_ALLOW_CREDENTIALS'>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='constant actix_web::http::header::ACCESS_CONTROL_ALLOW_HEADERS'>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='constant actix_web::http::header::ACCESS_CONTROL_ALLOW_METHODS'>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='constant actix_web::http::header::ACCESS_CONTROL_ALLOW_ORIGIN'>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='constant actix_web::http::header::ACCESS_CONTROL_EXPOSE_HEADERS'>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='constant actix_web::http::header::ACCESS_CONTROL_MAX_AGE'>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='constant actix_web::http::header::ACCESS_CONTROL_REQUEST_HEADERS'>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='constant actix_web::http::header::ACCESS_CONTROL_REQUEST_METHOD'>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='constant actix_web::http::header::AGE'>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='constant actix_web::http::header::ALLOW'>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='constant actix_web::http::header::ALT_SVC'>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='constant actix_web::http::header::AUTHORIZATION'>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='constant actix_web::http::header::CACHE_CONTROL'>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='constant actix_web::http::header::CONNECTION'>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='constant actix_web::http::header::CONTENT_DISPOSITION'>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='constant actix_web::http::header::CONTENT_ENCODING'>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='constant actix_web::http::header::CONTENT_LANGUAGE'>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='constant actix_web::http::header::CONTENT_LENGTH'>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='constant actix_web::http::header::CONTENT_LOCATION'>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='constant actix_web::http::header::CONTENT_RANGE'>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='constant actix_web::http::header::CONTENT_SECURITY_POLICY'>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='constant actix_web::http::header::CONTENT_SECURITY_POLICY_REPORT_ONLY'>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='constant actix_web::http::header::CONTENT_TYPE'>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='constant actix_web::http::header::COOKIE'>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='constant actix_web::http::header::DATE'>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='constant actix_web::http::header::DNT'>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='constant actix_web::http::header::ETAG'>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='constant actix_web::http::header::EXPECT'>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='constant actix_web::http::header::EXPIRES'>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='constant actix_web::http::header::FORWARDED'>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='constant actix_web::http::header::FROM'>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='constant actix_web::http::header::HOST'>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='constant actix_web::http::header::IF_MATCH'>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='constant actix_web::http::header::IF_MODIFIED_SINCE'>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='constant actix_web::http::header::IF_NONE_MATCH'>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='constant actix_web::http::header::IF_RANGE'>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='constant actix_web::http::header::IF_UNMODIFIED_SINCE'>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='constant actix_web::http::header::LAST_MODIFIED'>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='constant actix_web::http::header::LINK'>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='constant actix_web::http::header::LOCATION'>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='constant actix_web::http::header::MAX_FORWARDS'>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='constant actix_web::http::header::ORIGIN'>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='constant actix_web::http::header::PRAGMA'>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='constant actix_web::http::header::PROXY_AUTHENTICATE'>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='constant actix_web::http::header::PROXY_AUTHORIZATION'>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='constant actix_web::http::header::PUBLIC_KEY_PINS'>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='constant actix_web::http::header::PUBLIC_KEY_PINS_REPORT_ONLY'>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='constant actix_web::http::header::RANGE'>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='constant actix_web::http::header::REFERER'>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='constant actix_web::http::header::REFERRER_POLICY'>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='constant actix_web::http::header::REFRESH'>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='constant actix_web::http::header::RETRY_AFTER'>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='constant actix_web::http::header::SEC_WEBSOCKET_ACCEPT'>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='constant actix_web::http::header::SEC_WEBSOCKET_EXTENSIONS'>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='constant actix_web::http::header::SEC_WEBSOCKET_KEY'>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='constant actix_web::http::header::SEC_WEBSOCKET_PROTOCOL'>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='constant actix_web::http::header::SEC_WEBSOCKET_VERSION'>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='constant actix_web::http::header::SERVER'>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='constant actix_web::http::header::SET_COOKIE'>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='constant actix_web::http::header::STRICT_TRANSPORT_SECURITY'>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='constant actix_web::http::header::TE'>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='constant actix_web::http::header::TRAILER'>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='constant actix_web::http::header::TRANSFER_ENCODING'>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='constant actix_web::http::header::UPGRADE'>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='constant actix_web::http::header::UPGRADE_INSECURE_REQUESTS'>UPGRADE_INSECURE_REQUESTS</a></td>
<td class='docblock-short'>
<p>Sends a signal to the server expressing the clients preference for an
encrypted and authenticated response.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="constant" href="constant.USER_AGENT.html"
title='constant actix_web::http::header::USER_AGENT'>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='constant actix_web::http::header::VARY'>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='constant actix_web::http::header::VIA'>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='constant actix_web::http::header::WARNING'>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='constant actix_web::http::header::WWW_AUTHENTICATE'>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='constant actix_web::http::header::X_CONTENT_TYPE_OPTIONS'>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='constant actix_web::http::header::X_DNS_PREFETCH_CONTROL'>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='constant actix_web::http::header::X_FRAME_OPTIONS'>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='constant actix_web::http::header::X_XSS_PROTECTION'>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='trait actix_web::http::header::AsHeaderName'>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.IntoHeaderName.html"
title='trait actix_web::http::header::IntoHeaderName'>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></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='fn actix_web::http::header::http_percent_encode'>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='fn actix_web::http::header::parse_extended_value'>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><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>&#9166;</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>