mirror of
https://github.com/actix/actix-website
synced 2025-02-15 09:22:55 +01:00
171 lines
16 KiB
HTML
171 lines
16 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="Source to the Rust file `src/httpcodes.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>httpcodes.rs.html -- source</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 source"><!--[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">☰</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"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
<span id="28">28</span>
|
||
<span id="29">29</span>
|
||
<span id="30">30</span>
|
||
<span id="31">31</span>
|
||
<span id="32">32</span>
|
||
<span id="33">33</span>
|
||
<span id="34">34</span>
|
||
<span id="35">35</span>
|
||
<span id="36">36</span>
|
||
<span id="37">37</span>
|
||
<span id="38">38</span>
|
||
<span id="39">39</span>
|
||
<span id="40">40</span>
|
||
<span id="41">41</span>
|
||
<span id="42">42</span>
|
||
<span id="43">43</span>
|
||
<span id="44">44</span>
|
||
<span id="45">45</span>
|
||
<span id="46">46</span>
|
||
<span id="47">47</span>
|
||
<span id="48">48</span>
|
||
<span id="49">49</span>
|
||
<span id="50">50</span>
|
||
<span id="51">51</span>
|
||
<span id="52">52</span>
|
||
<span id="53">53</span>
|
||
<span id="54">54</span>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
<span id="61">61</span>
|
||
<span id="62">62</span>
|
||
<span id="63">63</span>
|
||
<span id="64">64</span>
|
||
<span id="65">65</span>
|
||
<span id="66">66</span>
|
||
<span id="67">67</span>
|
||
<span id="68">68</span>
|
||
<span id="69">69</span>
|
||
<span id="70">70</span>
|
||
<span id="71">71</span>
|
||
<span id="72">72</span>
|
||
<span id="73">73</span>
|
||
<span id="74">74</span>
|
||
<span id="75">75</span>
|
||
<span id="76">76</span>
|
||
<span id="77">77</span>
|
||
<span id="78">78</span>
|
||
<span id="79">79</span>
|
||
<span id="80">80</span>
|
||
<span id="81">81</span>
|
||
<span id="82">82</span>
|
||
<span id="83">83</span>
|
||
<span id="84">84</span>
|
||
</pre><pre class="rust ">
|
||
<span class="doccomment">//! Basic http responses</span>
|
||
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">non_upper_case_globals</span>)]</span>
|
||
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">StatusCode</span>;
|
||
<span class="kw">use</span> <span class="ident">httpresponse</span>::{<span class="ident">HttpResponse</span>, <span class="ident">HttpResponseBuilder</span>};
|
||
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">STATIC_RESP</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">status</span>:<span class="ident">expr</span>) <span class="op">=></span> {
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_snake_case</span>, <span class="ident">missing_docs</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>() <span class="op">-></span> <span class="ident">HttpResponseBuilder</span> {
|
||
<span class="ident">HttpResponse</span>::<span class="ident">build</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">status</span>)
|
||
}
|
||
};
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">HttpResponse</span> {
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>, <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Created</span>, <span class="ident">StatusCode</span>::<span class="ident">CREATED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Accepted</span>, <span class="ident">StatusCode</span>::<span class="ident">ACCEPTED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(
|
||
<span class="ident">NonAuthoritativeInformation</span>,
|
||
<span class="ident">StatusCode</span>::<span class="ident">NON_AUTHORITATIVE_INFORMATION</span>
|
||
);
|
||
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">NoContent</span>, <span class="ident">StatusCode</span>::<span class="ident">NO_CONTENT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">ResetContent</span>, <span class="ident">StatusCode</span>::<span class="ident">RESET_CONTENT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">PartialContent</span>, <span class="ident">StatusCode</span>::<span class="ident">PARTIAL_CONTENT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">MultiStatus</span>, <span class="ident">StatusCode</span>::<span class="ident">MULTI_STATUS</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">AlreadyReported</span>, <span class="ident">StatusCode</span>::<span class="ident">ALREADY_REPORTED</span>);
|
||
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">MultipleChoices</span>, <span class="ident">StatusCode</span>::<span class="ident">MULTIPLE_CHOICES</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">MovedPermanenty</span>, <span class="ident">StatusCode</span>::<span class="ident">MOVED_PERMANENTLY</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">MovedPermanently</span>, <span class="ident">StatusCode</span>::<span class="ident">MOVED_PERMANENTLY</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Found</span>, <span class="ident">StatusCode</span>::<span class="ident">FOUND</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">SeeOther</span>, <span class="ident">StatusCode</span>::<span class="ident">SEE_OTHER</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">NotModified</span>, <span class="ident">StatusCode</span>::<span class="ident">NOT_MODIFIED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">UseProxy</span>, <span class="ident">StatusCode</span>::<span class="ident">USE_PROXY</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">TemporaryRedirect</span>, <span class="ident">StatusCode</span>::<span class="ident">TEMPORARY_REDIRECT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">PermanentRedirect</span>, <span class="ident">StatusCode</span>::<span class="ident">PERMANENT_REDIRECT</span>);
|
||
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">BadRequest</span>, <span class="ident">StatusCode</span>::<span class="ident">BAD_REQUEST</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">NotFound</span>, <span class="ident">StatusCode</span>::<span class="ident">NOT_FOUND</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Unauthorized</span>, <span class="ident">StatusCode</span>::<span class="ident">UNAUTHORIZED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">PaymentRequired</span>, <span class="ident">StatusCode</span>::<span class="ident">PAYMENT_REQUIRED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Forbidden</span>, <span class="ident">StatusCode</span>::<span class="ident">FORBIDDEN</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">MethodNotAllowed</span>, <span class="ident">StatusCode</span>::<span class="ident">METHOD_NOT_ALLOWED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">NotAcceptable</span>, <span class="ident">StatusCode</span>::<span class="ident">NOT_ACCEPTABLE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(
|
||
<span class="ident">ProxyAuthenticationRequired</span>,
|
||
<span class="ident">StatusCode</span>::<span class="ident">PROXY_AUTHENTICATION_REQUIRED</span>
|
||
);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">RequestTimeout</span>, <span class="ident">StatusCode</span>::<span class="ident">REQUEST_TIMEOUT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Conflict</span>, <span class="ident">StatusCode</span>::<span class="ident">CONFLICT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">Gone</span>, <span class="ident">StatusCode</span>::<span class="ident">GONE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">LengthRequired</span>, <span class="ident">StatusCode</span>::<span class="ident">LENGTH_REQUIRED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">PreconditionFailed</span>, <span class="ident">StatusCode</span>::<span class="ident">PRECONDITION_FAILED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">PayloadTooLarge</span>, <span class="ident">StatusCode</span>::<span class="ident">PAYLOAD_TOO_LARGE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">UriTooLong</span>, <span class="ident">StatusCode</span>::<span class="ident">URI_TOO_LONG</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">UnsupportedMediaType</span>, <span class="ident">StatusCode</span>::<span class="ident">UNSUPPORTED_MEDIA_TYPE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">RangeNotSatisfiable</span>, <span class="ident">StatusCode</span>::<span class="ident">RANGE_NOT_SATISFIABLE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">ExpectationFailed</span>, <span class="ident">StatusCode</span>::<span class="ident">EXPECTATION_FAILED</span>);
|
||
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">InternalServerError</span>, <span class="ident">StatusCode</span>::<span class="ident">INTERNAL_SERVER_ERROR</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">NotImplemented</span>, <span class="ident">StatusCode</span>::<span class="ident">NOT_IMPLEMENTED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">BadGateway</span>, <span class="ident">StatusCode</span>::<span class="ident">BAD_GATEWAY</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">ServiceUnavailable</span>, <span class="ident">StatusCode</span>::<span class="ident">SERVICE_UNAVAILABLE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">GatewayTimeout</span>, <span class="ident">StatusCode</span>::<span class="ident">GATEWAY_TIMEOUT</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">VersionNotSupported</span>, <span class="ident">StatusCode</span>::<span class="ident">HTTP_VERSION_NOT_SUPPORTED</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">VariantAlsoNegotiates</span>, <span class="ident">StatusCode</span>::<span class="ident">VARIANT_ALSO_NEGOTIATES</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">InsufficientStorage</span>, <span class="ident">StatusCode</span>::<span class="ident">INSUFFICIENT_STORAGE</span>);
|
||
<span class="macro">STATIC_RESP</span><span class="macro">!</span>(<span class="ident">LoopDetected</span>, <span class="ident">StatusCode</span>::<span class="ident">LOOP_DETECTED</span>);
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||
<span class="kw">use</span> <span class="ident">body</span>::<span class="ident">Body</span>;
|
||
<span class="kw">use</span> <span class="ident">http</span>::<span class="ident">StatusCode</span>;
|
||
<span class="kw">use</span> <span class="ident">httpresponse</span>::<span class="ident">HttpResponse</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||
<span class="kw">fn</span> <span class="ident">test_build</span>() {
|
||
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">body</span>(<span class="ident">Body</span>::<span class="ident">Empty</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
|
||
}
|
||
}
|
||
</pre>
|
||
</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>⏎</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> |