232 lines
No EOL
18 KiB
HTML
232 lines
No EOL
18 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 `EntityTag` struct in crate `iron`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, EntityTag">
|
||
|
||
<title>iron::headers::EntityTag - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
<link rel="shortcut icon" href="https://avatars0.githubusercontent.com/u/7853871?s=256">
|
||
|
||
</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">
|
||
<a href='../../iron/index.html'><img src='https://avatars0.githubusercontent.com/u/7853871?s=128' alt='logo' width='100'></a>
|
||
<p class='location'><a href='../index.html'>iron</a>::<wbr><a href='index.html'>headers</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'>iron</a>::<wbr><a href='index.html'>headers</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'>−</span>]
|
||
</a>
|
||
</span><a id='src-4982' class='srclink' href='../../hyper/header/shared/entity/struct.EntityTag.html?gotosrc=4982' 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>"xyzzy"</code> and <code>W/"xyzzy"</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 ; "W/", 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/"1"</code></td>
|
||
<td><code>W/"1"</code></td>
|
||
<td>no match</td>
|
||
<td>match</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>W/"1"</code></td>
|
||
<td><code>W/"2"</code></td>
|
||
<td>no match</td>
|
||
<td>no match</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>W/"1"</code></td>
|
||
<td><code>"1"</code></td>
|
||
<td>no match</td>
|
||
<td>match</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>"1"</code></td>
|
||
<td><code>"1"</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><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(weak: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a>, tag: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>) -> <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></h4>
|
||
<div class='docblock'><p>Constructs a new EntityTag.</p>
|
||
|
||
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
|
||
<p>If the tag contains invalid characters.</p>
|
||
</div><h4 id='method.weak' class='method'><code>fn <a href='#method.weak' class='fnname'>weak</a>(tag: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>) -> <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></h4>
|
||
<div class='docblock'><p>Constructs a new weak EntityTag.</p>
|
||
|
||
<h1 id='panics-1' class='section-header'><a href='#panics-1'>Panics</a></h1>
|
||
<p>If the tag contains invalid characters.</p>
|
||
</div><h4 id='method.strong' class='method'><code>fn <a href='#method.strong' class='fnname'>strong</a>(tag: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>) -> <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></h4>
|
||
<div class='docblock'><p>Constructs a new strong EntityTag.</p>
|
||
|
||
<h1 id='panics-2' class='section-header'><a href='#panics-2'>Panics</a></h1>
|
||
<p>If the tag contains invalid characters.</p>
|
||
</div><h4 id='method.tag' class='method'><code>fn <a href='#method.tag' class='fnname'>tag</a>(&self) -> &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></h4>
|
||
<div class='docblock'><p>Get the tag.</p>
|
||
</div><h4 id='method.set_tag' class='method'><code>fn <a href='#method.set_tag' class='fnname'>set_tag</a>(&mut self, tag: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>)</code></h4>
|
||
<div class='docblock'><p>Set the tag.</p>
|
||
|
||
<h1 id='panics-3' class='section-header'><a href='#panics-3'>Panics</a></h1>
|
||
<p>If the tag contains invalid characters.</p>
|
||
</div><h4 id='method.strong_eq' class='method'><code>fn <a href='#method.strong_eq' class='fnname'>strong_eq</a>(&self, other: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>For strong comparison two entity-tags are equivalent if both are not weak and their
|
||
opaque-tags match character-by-character.</p>
|
||
</div><h4 id='method.weak_eq' class='method'><code>fn <a href='#method.weak_eq' class='fnname'>weak_eq</a>(&self, other: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>For weak comparison two entity-tags are equivalent if their
|
||
opaque-tags match character-by-character, regardless of either or
|
||
both being tagged as "weak".</p>
|
||
</div><h4 id='method.strong_ne' class='method'><code>fn <a href='#method.strong_ne' class='fnname'>strong_ne</a>(&self, other: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>The inverse of <code>EntityTag.strong_eq()</code>.</p>
|
||
</div><h4 id='method.weak_ne' class='method'><code>fn <a href='#method.weak_ne' class='fnname'>weak_ne</a>(&self, other: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>The inverse of <code>EntityTag.weak_eq()</code>.</p>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a><<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id='method.ne' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title='core::cmp::Eq'>Eq</a> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title='core::fmt::Error'>Error</a>></code></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title='core::fmt::Display'>Display</a> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt-1' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>, <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title='core::fmt::Error'>Error</a>></code></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html' title='core::str::FromStr'>FromStr</a> for <a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Err' class='type'><code>type <a href='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#associatedtype.Err' class='type'>Err</a> = <a class='enum' href='../../iron/error/enum.HttpError.html' title='iron::error::HttpError'>Error</a></code></h4>
|
||
<h4 id='method.from_str' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html#tymethod.from_str' class='fnname'>from_str</a>(s: &<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='struct' href='../../iron/headers/struct.EntityTag.html' title='iron::headers::EntityTag'>EntityTag</a>, <a class='enum' href='../../iron/error/enum.HttpError.html' title='iron::error::HttpError'>Error</a>></code></h4>
|
||
</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 = "iron";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |