juniper/hyper/header/struct.EntityTag.html
Juniper Documentation Builder 95d942c9d4 Update documentation for Juniper
2016-09-11 18:41:24 +00:00

178 lines
No EOL
6.2 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 `EntityTag` struct in crate `hyper`.">
<meta name="keywords" content="rust, rustlang, rust-lang, EntityTag">
<title>hyper::header::EntityTag - 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: 'EntityTag', 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=''>EntityTag</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 id='src-4982' class='srclink' href='../../src/hyper/header/shared/entity.rs.html#43-48' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct EntityTag {
pub weak: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>,
// some fields omitted
}</pre><div class='docblock'><p>An entity tag, defined in <a href="https://tools.ietf.org/html/rfc7232#section-2.3">RFC7232</a></p>
<p>An entity tag consists of a string enclosed by two literal double quotes.
Preceding the first double quote is an optional weakness indicator,
which always looks like <code>W/</code>. Examples for valid tags are <code>&quot;xyzzy&quot;</code> and <code>W/&quot;xyzzy&quot;</code>.</p>
<h1 id='abnf' class='section-header'><a href='#abnf'>ABNF</a></h1>
<pre><code class="language-plain">entity-tag = [ weak ] opaque-tag
weak = %x57.2F ; &quot;W/&quot;, case-sensitive
opaque-tag = DQUOTE *etagc DQUOTE
etagc = %x21 / %x23-7E / obs-text
; VCHAR except double quotes, plus obs-text
</code></pre>
<h1 id='comparison' class='section-header'><a href='#comparison'>Comparison</a></h1>
<p>To check if two entity tags are equivalent in an application always use the <code>strong_eq</code> or
<code>weak_eq</code> methods based on the context of the Tag. Only use <code>==</code> to check if two tags are
identical.</p>
<p>The example below shows the results for a set of entity-tag pairs and
both the weak and strong comparison function results:</p>
<table>
<thead>
<tr>
<th>ETag 1</th>
<th>ETag 2</th>
<th>Strong Comparison</th>
<th>Weak Comparison</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>W/&quot;1&quot;</code></td>
<td><code>W/&quot;1&quot;</code></td>
<td>no match</td>
<td>match</td>
</tr>
<tr>
<td><code>W/&quot;1&quot;</code></td>
<td><code>W/&quot;2&quot;</code></td>
<td>no match</td>
<td>no match</td>
</tr>
<tr>
<td><code>W/&quot;1&quot;</code></td>
<td><code>&quot;1&quot;</code></td>
<td>no match</td>
<td>match</td>
</tr>
<tr>
<td><code>&quot;1&quot;</code></td>
<td><code>&quot;1&quot;</code></td>
<td>match</td>
<td>match</td>
</tr>
</tbody>
</table>
</div><h2 class='fields'>Fields</h2><span id='structfield.weak' class='structfield'><code>weak: <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>Weakness indicator for the tag</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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>