actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-06-30 16:54:27 +02:00
Code Issues Releases Wiki Activity

Add api docs

Browse Source
This commit is contained in:
Nikolay Kim
2018-07-21 04:09:47 -07:00
parent 35a9469409
commit 52a58cc626
5528 changed files with 266014 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
static/api/actix-web/0.7.0/stable/http/header/constant.IF_MATCH.html Normal file
View File

@ -0,0 +1,25 @@
<!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 `IF_MATCH` constant in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, IF_MATCH"><title>actix_web::http::header::IF_MATCH - 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 constant"><!--[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><div class="sidebar-elems"><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a></p><script>window.sidebarCurrent = {name: 'IF_MATCH', ty: 'constant', 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'>Constant <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>http</a>::<wbr><a href='index.html'>header</a>::<wbr><a class="constant" href=''>IF_MATCH</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='https://docs.rs/http/0.1.7/src/http/header/name.rs.html#84-86' title='goto source code'>[src]</a></span></h1><pre class='rust const'>pub const IF_MATCH: <a class="struct" href="../../../actix_web/http/header/struct.HeaderName.html" title="struct actix_web::http::header::HeaderName">HeaderName</a><code> = </code><code>HeaderName{inner: Repr::Standard(StandardHeader::IfMatch),}</code></pre><div class='docblock'><p>Makes a request conditional based on the E-Tag.</p>
<p>For GET and HEAD methods, the server will send back the requested
resource only if it matches one of the listed ETags. For PUT and other
non-safe methods, it will only upload the resource in this case.</p>
<p>The comparison with the stored ETag uses the strong comparison
algorithm, meaning two files are considered identical byte to byte only.
This is weakened when the W/ prefix is used in front of the ETag.</p>
<p>There are two common use cases:</p>
<ul>
<li>
<p>For GET and HEAD methods, used in combination with an Range header, it
can guarantee that the new ranges requested comes from the same resource
than the previous one. If it doesn't match, then a 416 (Range Not
Satisfiable) response is returned.</p>
</li>
<li>
<p>For other methods, and in particular for PUT, If-Match can be used to
prevent the lost update problem. It can check if the modification of a
resource that the user wants to upload will not override another change
that has been done since the original resource was fetched. If the
request cannot be fulfilled, the 412 (Precondition Failed) response is
returned.</p>
</li>
</ul>
</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><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>