158 lines
No EOL
7 KiB
HTML
158 lines
No EOL
7 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 `StrictTransportSecurity` struct in crate `hyper`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, StrictTransportSecurity">
|
||
|
||
<title>hyper::header::StrictTransportSecurity - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../index.html'>hyper</a>::<wbr><a href='index.html'>header</a></p><script>window.sidebarCurrent = {name: 'StrictTransportSecurity', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>hyper</a>::<wbr><a href='index.html'>header</a>::<wbr><a class='struct' href=''>StrictTransportSecurity</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'>−</span>]
|
||
</a>
|
||
</span><a id='src-4247' class='srclink' href='../../src/hyper/header/common/strict_transport_security.rs.html#47-56' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct StrictTransportSecurity {
|
||
pub include_subdomains: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>,
|
||
pub max_age: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a>,
|
||
}</pre><div class='docblock'><p><code>StrictTransportSecurity</code> header, defined in <a href="https://tools.ietf.org/html/rfc6797">RFC6797</a></p>
|
||
|
||
<p>This specification defines a mechanism enabling web sites to declare
|
||
themselves accessible only via secure connections and/or for users to be
|
||
able to direct their user agent(s) to interact with given sites only over
|
||
secure connections. This overall policy is referred to as HTTP Strict
|
||
Transport Security (HSTS). The policy is declared by web sites via the
|
||
Strict-Transport-Security HTTP response header field and/or by other means,
|
||
such as user agent configuration, for example.</p>
|
||
|
||
<h1 id='abnf' class='section-header'><a href='#abnf'>ABNF</a></h1>
|
||
<pre><code class="language-plain"> [ directive ] *( ";" [ directive ] )
|
||
|
||
directive = directive-name [ "=" directive-value ]
|
||
directive-name = token
|
||
directive-value = token | quoted-string
|
||
|
||
</code></pre>
|
||
|
||
<h1 id='example-values' class='section-header'><a href='#example-values'>Example values</a></h1>
|
||
<ul>
|
||
<li><code>max-age=31536000</code></li>
|
||
<li><code>max-age=15768000 ; includeSubDomains</code></li>
|
||
</ul>
|
||
|
||
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>hyper</span>::<span class='ident'>header</span>::{<span class='ident'>Headers</span>, <span class='ident'>StrictTransportSecurity</span>};
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>headers</span> <span class='op'>=</span> <span class='ident'>Headers</span>::<span class='ident'>new</span>();
|
||
|
||
<span class='ident'>headers</span>.<span class='ident'>set</span>(
|
||
<span class='ident'>StrictTransportSecurity</span>::<span class='ident'>including_subdomains</span>(<span class='number'>31536000u64</span>)
|
||
);</pre>
|
||
</div><h2 class='fields'>Fields</h2><span id='structfield.include_subdomains' class='structfield'><code>include_subdomains: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code>
|
||
</span><span class='stab '></span><div class='docblock'><p>Signals the UA that the HSTS Policy applies to this HSTS Host as well as
|
||
any subdomains of the host's domain name.</p>
|
||
</div><span id='structfield.max_age' class='structfield'><code>max_age: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a></code>
|
||
</span><span class='stab '></span><div class='docblock'><p>Specifies the number of seconds, after the reception of the STS header
|
||
field, during which the UA regards the host (from whom the message was
|
||
received) as a Known HSTS Host.</p>
|
||
</div></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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "hyper";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |