378 lines
No EOL
33 KiB
HTML
378 lines
No EOL
33 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 `Status` enum in crate `iron`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Status">
|
||
|
||
<title>iron::status::Status - 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'>status</a></p><script>window.sidebarCurrent = {name: 'Status', ty: 'enum', 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 enum">
|
||
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>iron</a>::<wbr><a href='index.html'>status</a>::<wbr><a class='enum' href=''>Status</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-7836' class='srclink' href='../../hyper/status/enum.StatusCode.html?gotosrc=7836' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust enum'>pub enum Status {
|
||
Continue,
|
||
SwitchingProtocols,
|
||
Processing,
|
||
Ok,
|
||
Created,
|
||
Accepted,
|
||
NonAuthoritativeInformation,
|
||
NoContent,
|
||
ResetContent,
|
||
PartialContent,
|
||
MultiStatus,
|
||
AlreadyReported,
|
||
ImUsed,
|
||
MultipleChoices,
|
||
MovedPermanently,
|
||
Found,
|
||
SeeOther,
|
||
NotModified,
|
||
UseProxy,
|
||
TemporaryRedirect,
|
||
PermanentRedirect,
|
||
BadRequest,
|
||
Unauthorized,
|
||
PaymentRequired,
|
||
Forbidden,
|
||
NotFound,
|
||
MethodNotAllowed,
|
||
NotAcceptable,
|
||
ProxyAuthenticationRequired,
|
||
RequestTimeout,
|
||
Conflict,
|
||
Gone,
|
||
LengthRequired,
|
||
PreconditionFailed,
|
||
PayloadTooLarge,
|
||
UriTooLong,
|
||
UnsupportedMediaType,
|
||
RangeNotSatisfiable,
|
||
ExpectationFailed,
|
||
ImATeapot,
|
||
MisdirectedRequest,
|
||
UnprocessableEntity,
|
||
Locked,
|
||
FailedDependency,
|
||
UpgradeRequired,
|
||
PreconditionRequired,
|
||
TooManyRequests,
|
||
RequestHeaderFieldsTooLarge,
|
||
UnavailableForLegalReasons,
|
||
InternalServerError,
|
||
NotImplemented,
|
||
BadGateway,
|
||
ServiceUnavailable,
|
||
GatewayTimeout,
|
||
HttpVersionNotSupported,
|
||
VariantAlsoNegotiates,
|
||
InsufficientStorage,
|
||
LoopDetected,
|
||
NotExtended,
|
||
NetworkAuthenticationRequired,
|
||
Unregistered(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a>),
|
||
}</pre><div class='docblock'><p>An HTTP status code (<code>status-code</code> in RFC 7230 et al.).</p>
|
||
|
||
<p>This enum contains all common status codes and an Unregistered
|
||
extension variant. It allows status codes in the range [0, 65535], as any
|
||
<code>u16</code> integer may be used as a status code for XHR requests. It is
|
||
recommended to only use values between [100, 599], since only these are
|
||
defined as valid status codes with a status class by HTTP.</p>
|
||
|
||
<p>If you encounter a status code that you do not know how to deal with, you
|
||
should treat it as the <code>x00</code> status code—e.g. for code 123, treat it as
|
||
100 (Continue). This can be achieved with
|
||
<code>self.class().default_code()</code>:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>let</span> <span class='ident'>status</span> <span class='op'>=</span> <span class='ident'>StatusCode</span>::<span class='ident'>Unregistered</span>(<span class='number'>123</span>);
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>status</span>.<span class='ident'>class</span>().<span class='ident'>default_code</span>(), <span class='ident'>StatusCode</span>::<span class='ident'>Continue</span>);</pre>
|
||
|
||
<p>IANA maintain the <a href="http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">Hypertext Transfer Protocol (HTTP) Status Code
|
||
Registry</a> which is
|
||
the source for this enum (with one exception, 418 I'm a teapot, which is
|
||
inexplicably not in the register).</p>
|
||
</div><h2 class='variants'>Variants</h2>
|
||
<span id='variant.Continue' class='variant'><code>Continue</code></span><div class='docblock'><p>100 Continue
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.2.1">RFC7231, Section 6.2.1</a>]</p>
|
||
</div><span id='variant.SwitchingProtocols' class='variant'><code>SwitchingProtocols</code></span><div class='docblock'><p>101 Switching Protocols
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.2.2">RFC7231, Section 6.2.2</a>]</p>
|
||
</div><span id='variant.Processing' class='variant'><code>Processing</code></span><div class='docblock'><p>102 Processing
|
||
[<a href="https://tools.ietf.org/html/rfc2518">RFC2518</a>]</p>
|
||
</div><span id='variant.Ok' class='variant'><code>Ok</code></span><div class='docblock'><p>200 OK
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">RFC7231, Section 6.3.1</a>]</p>
|
||
</div><span id='variant.Created' class='variant'><code>Created</code></span><div class='docblock'><p>201 Created
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.2">RFC7231, Section 6.3.2</a>]</p>
|
||
</div><span id='variant.Accepted' class='variant'><code>Accepted</code></span><div class='docblock'><p>202 Accepted
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.3">RFC7231, Section 6.3.3</a>]</p>
|
||
</div><span id='variant.NonAuthoritativeInformation' class='variant'><code>NonAuthoritativeInformation</code></span><div class='docblock'><p>203 Non-Authoritative Information
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.4">RFC7231, Section 6.3.4</a>]</p>
|
||
</div><span id='variant.NoContent' class='variant'><code>NoContent</code></span><div class='docblock'><p>204 No Content
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.5">RFC7231, Section 6.3.5</a>]</p>
|
||
</div><span id='variant.ResetContent' class='variant'><code>ResetContent</code></span><div class='docblock'><p>205 Reset Content
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.3.6">RFC7231, Section 6.3.6</a>]</p>
|
||
</div><span id='variant.PartialContent' class='variant'><code>PartialContent</code></span><div class='docblock'><p>206 Partial Content
|
||
[<a href="https://tools.ietf.org/html/rfc7233#section-4.1">RFC7233, Section 4.1</a>]</p>
|
||
</div><span id='variant.MultiStatus' class='variant'><code>MultiStatus</code></span><div class='docblock'><p>207 Multi-Status
|
||
[<a href="https://tools.ietf.org/html/rfc4918">RFC4918</a>]</p>
|
||
</div><span id='variant.AlreadyReported' class='variant'><code>AlreadyReported</code></span><div class='docblock'><p>208 Already Reported
|
||
[<a href="https://tools.ietf.org/html/rfc5842">RFC5842</a>]</p>
|
||
</div><span id='variant.ImUsed' class='variant'><code>ImUsed</code></span><div class='docblock'><p>226 IM Used
|
||
[<a href="https://tools.ietf.org/html/rfc3229">RFC3229</a>]</p>
|
||
</div><span id='variant.MultipleChoices' class='variant'><code>MultipleChoices</code></span><div class='docblock'><p>300 Multiple Choices
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.1">RFC7231, Section 6.4.1</a>]</p>
|
||
</div><span id='variant.MovedPermanently' class='variant'><code>MovedPermanently</code></span><div class='docblock'><p>301 Moved Permanently
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.2">RFC7231, Section 6.4.2</a>]</p>
|
||
</div><span id='variant.Found' class='variant'><code>Found</code></span><div class='docblock'><p>302 Found
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.3">RFC7231, Section 6.4.3</a>]</p>
|
||
</div><span id='variant.SeeOther' class='variant'><code>SeeOther</code></span><div class='docblock'><p>303 See Other
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.4">RFC7231, Section 6.4.4</a>]</p>
|
||
</div><span id='variant.NotModified' class='variant'><code>NotModified</code></span><div class='docblock'><p>304 Not Modified
|
||
[<a href="https://tools.ietf.org/html/rfc7232#section-4.1">RFC7232, Section 4.1</a>]</p>
|
||
</div><span id='variant.UseProxy' class='variant'><code>UseProxy</code></span><div class='docblock'><p>305 Use Proxy
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.5">RFC7231, Section 6.4.5</a>]</p>
|
||
</div><span id='variant.TemporaryRedirect' class='variant'><code>TemporaryRedirect</code></span><div class='docblock'><p>307 Temporary Redirect
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.4.7">RFC7231, Section 6.4.7</a>]</p>
|
||
</div><span id='variant.PermanentRedirect' class='variant'><code>PermanentRedirect</code></span><div class='docblock'><p>308 Permanent Redirect
|
||
[<a href="https://tools.ietf.org/html/rfc7238">RFC7238</a>]</p>
|
||
</div><span id='variant.BadRequest' class='variant'><code>BadRequest</code></span><div class='docblock'><p>400 Bad Request
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.1">RFC7231, Section 6.5.1</a>]</p>
|
||
</div><span id='variant.Unauthorized' class='variant'><code>Unauthorized</code></span><div class='docblock'><p>401 Unauthorized
|
||
[<a href="https://tools.ietf.org/html/rfc7235#section-3.1">RFC7235, Section 3.1</a>]</p>
|
||
</div><span id='variant.PaymentRequired' class='variant'><code>PaymentRequired</code></span><div class='docblock'><p>402 Payment Required
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.2">RFC7231, Section 6.5.2</a>]</p>
|
||
</div><span id='variant.Forbidden' class='variant'><code>Forbidden</code></span><div class='docblock'><p>403 Forbidden
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.3">RFC7231, Section 6.5.3</a>]</p>
|
||
</div><span id='variant.NotFound' class='variant'><code>NotFound</code></span><div class='docblock'><p>404 Not Found
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.4">RFC7231, Section 6.5.4</a>]</p>
|
||
</div><span id='variant.MethodNotAllowed' class='variant'><code>MethodNotAllowed</code></span><div class='docblock'><p>405 Method Not Allowed
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.5">RFC7231, Section 6.5.5</a>]</p>
|
||
</div><span id='variant.NotAcceptable' class='variant'><code>NotAcceptable</code></span><div class='docblock'><p>406 Not Acceptable
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.6">RFC7231, Section 6.5.6</a>]</p>
|
||
</div><span id='variant.ProxyAuthenticationRequired' class='variant'><code>ProxyAuthenticationRequired</code></span><div class='docblock'><p>407 Proxy Authentication Required
|
||
[<a href="https://tools.ietf.org/html/rfc7235#section-3.2">RFC7235, Section 3.2</a>]</p>
|
||
</div><span id='variant.RequestTimeout' class='variant'><code>RequestTimeout</code></span><div class='docblock'><p>408 Request Timeout
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.7">RFC7231, Section 6.5.7</a>]</p>
|
||
</div><span id='variant.Conflict' class='variant'><code>Conflict</code></span><div class='docblock'><p>409 Conflict
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.8">RFC7231, Section 6.5.8</a>]</p>
|
||
</div><span id='variant.Gone' class='variant'><code>Gone</code></span><div class='docblock'><p>410 Gone
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.9">RFC7231, Section 6.5.9</a>]</p>
|
||
</div><span id='variant.LengthRequired' class='variant'><code>LengthRequired</code></span><div class='docblock'><p>411 Length Required
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.10">RFC7231, Section 6.5.10</a>]</p>
|
||
</div><span id='variant.PreconditionFailed' class='variant'><code>PreconditionFailed</code></span><div class='docblock'><p>412 Precondition Failed
|
||
[<a href="https://tools.ietf.org/html/rfc7232#section-4.2">RFC7232, Section 4.2</a>]</p>
|
||
</div><span id='variant.PayloadTooLarge' class='variant'><code>PayloadTooLarge</code></span><div class='docblock'><p>413 Payload Too Large
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.11">RFC7231, Section 6.5.11</a>]</p>
|
||
</div><span id='variant.UriTooLong' class='variant'><code>UriTooLong</code></span><div class='docblock'><p>414 URI Too Long
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.12">RFC7231, Section 6.5.12</a>]</p>
|
||
</div><span id='variant.UnsupportedMediaType' class='variant'><code>UnsupportedMediaType</code></span><div class='docblock'><p>415 Unsupported Media Type
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.13">RFC7231, Section 6.5.13</a>]</p>
|
||
</div><span id='variant.RangeNotSatisfiable' class='variant'><code>RangeNotSatisfiable</code></span><div class='docblock'><p>416 Range Not Satisfiable
|
||
[<a href="https://tools.ietf.org/html/rfc7233#section-4.4">RFC7233, Section 4.4</a>]</p>
|
||
</div><span id='variant.ExpectationFailed' class='variant'><code>ExpectationFailed</code></span><div class='docblock'><p>417 Expectation Failed
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.14">RFC7231, Section 6.5.14</a>]</p>
|
||
</div><span id='variant.ImATeapot' class='variant'><code>ImATeapot</code></span><div class='docblock'><p>418 I'm a teapot
|
||
[curiously, not registered by IANA, but <a href="https://tools.ietf.org/html/rfc2324">RFC2324</a>]</p>
|
||
</div><span id='variant.MisdirectedRequest' class='variant'><code>MisdirectedRequest</code></span><div class='docblock'><p>421 Misdirected Request
|
||
<a href="http://tools.ietf.org/html/rfc7540#section-9.1.2">RFC7540, Section 9.1.2</a></p>
|
||
</div><span id='variant.UnprocessableEntity' class='variant'><code>UnprocessableEntity</code></span><div class='docblock'><p>422 Unprocessable Entity
|
||
[<a href="https://tools.ietf.org/html/rfc4918">RFC4918</a>]</p>
|
||
</div><span id='variant.Locked' class='variant'><code>Locked</code></span><div class='docblock'><p>423 Locked
|
||
[<a href="https://tools.ietf.org/html/rfc4918">RFC4918</a>]</p>
|
||
</div><span id='variant.FailedDependency' class='variant'><code>FailedDependency</code></span><div class='docblock'><p>424 Failed Dependency
|
||
[<a href="https://tools.ietf.org/html/rfc4918">RFC4918</a>]</p>
|
||
</div><span id='variant.UpgradeRequired' class='variant'><code>UpgradeRequired</code></span><div class='docblock'><p>426 Upgrade Required
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.5.15">RFC7231, Section 6.5.15</a>]</p>
|
||
</div><span id='variant.PreconditionRequired' class='variant'><code>PreconditionRequired</code></span><div class='docblock'><p>428 Precondition Required
|
||
[<a href="https://tools.ietf.org/html/rfc6585">RFC6585</a>]</p>
|
||
</div><span id='variant.TooManyRequests' class='variant'><code>TooManyRequests</code></span><div class='docblock'><p>429 Too Many Requests
|
||
[<a href="https://tools.ietf.org/html/rfc6585">RFC6585</a>]</p>
|
||
</div><span id='variant.RequestHeaderFieldsTooLarge' class='variant'><code>RequestHeaderFieldsTooLarge</code></span><div class='docblock'><p>431 Request Header Fields Too Large
|
||
[<a href="https://tools.ietf.org/html/rfc6585">RFC6585</a>]</p>
|
||
</div><span id='variant.UnavailableForLegalReasons' class='variant'><code>UnavailableForLegalReasons</code></span><div class='docblock'><p>451 Unavailable For Legal Reasons
|
||
[<a href="http://tools.ietf.org/html/rfc7725">RFC7725</a>]</p>
|
||
</div><span id='variant.InternalServerError' class='variant'><code>InternalServerError</code></span><div class='docblock'><p>500 Internal Server Error
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.1">RFC7231, Section 6.6.1</a>]</p>
|
||
</div><span id='variant.NotImplemented' class='variant'><code>NotImplemented</code></span><div class='docblock'><p>501 Not Implemented
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.2">RFC7231, Section 6.6.2</a>]</p>
|
||
</div><span id='variant.BadGateway' class='variant'><code>BadGateway</code></span><div class='docblock'><p>502 Bad Gateway
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.3">RFC7231, Section 6.6.3</a>]</p>
|
||
</div><span id='variant.ServiceUnavailable' class='variant'><code>ServiceUnavailable</code></span><div class='docblock'><p>503 Service Unavailable
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.4">RFC7231, Section 6.6.4</a>]</p>
|
||
</div><span id='variant.GatewayTimeout' class='variant'><code>GatewayTimeout</code></span><div class='docblock'><p>504 Gateway Timeout
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.5">RFC7231, Section 6.6.5</a>]</p>
|
||
</div><span id='variant.HttpVersionNotSupported' class='variant'><code>HttpVersionNotSupported</code></span><div class='docblock'><p>505 HTTP Version Not Supported
|
||
[<a href="https://tools.ietf.org/html/rfc7231#section-6.6.6">RFC7231, Section 6.6.6</a>]</p>
|
||
</div><span id='variant.VariantAlsoNegotiates' class='variant'><code>VariantAlsoNegotiates</code></span><div class='docblock'><p>506 Variant Also Negotiates
|
||
[<a href="https://tools.ietf.org/html/rfc2295">RFC2295</a>]</p>
|
||
</div><span id='variant.InsufficientStorage' class='variant'><code>InsufficientStorage</code></span><div class='docblock'><p>507 Insufficient Storage
|
||
[<a href="https://tools.ietf.org/html/rfc4918">RFC4918</a>]</p>
|
||
</div><span id='variant.LoopDetected' class='variant'><code>LoopDetected</code></span><div class='docblock'><p>508 Loop Detected
|
||
[<a href="https://tools.ietf.org/html/rfc5842">RFC5842</a>]</p>
|
||
</div><span id='variant.NotExtended' class='variant'><code>NotExtended</code></span><div class='docblock'><p>510 Not Extended
|
||
[<a href="https://tools.ietf.org/html/rfc2774">RFC2774</a>]</p>
|
||
</div><span id='variant.NetworkAuthenticationRequired' class='variant'><code>NetworkAuthenticationRequired</code></span><div class='docblock'><p>511 Network Authentication Required
|
||
[<a href="https://tools.ietf.org/html/rfc6585">RFC6585</a>]</p>
|
||
</div><span id='variant.Unregistered' class='variant'><code>Unregistered(<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a>)</code></span><div class='docblock'><p>A status code not in the IANA HTTP status code registry or very well known</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.canonical_reason' class='method'><code>fn <a href='#method.canonical_reason' class='fnname'>canonical_reason</a>(&self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&'static <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>></code></h4>
|
||
<div class='docblock'><p>Get the standardised <code>reason-phrase</code> for this status code.</p>
|
||
|
||
<p>This is mostly here for servers writing responses, but could potentially have application
|
||
at other times.</p>
|
||
|
||
<p>The reason phrase is defined as being exclusively for human readers. You should avoid
|
||
deriving any meaning from it at all costs.</p>
|
||
|
||
<p>Bear in mind also that in HTTP/2.0 the reason phrase is abolished from transmission, and so
|
||
this canonical reason phrase really is the only reason phrase you’ll find.</p>
|
||
</div><h4 id='method.class' class='method'><code>fn <a href='#method.class' class='fnname'>class</a>(&self) -> <a class='enum' href='../../iron/status/enum.StatusClass.html' title='iron::status::StatusClass'>StatusClass</a></code></h4>
|
||
<div class='docblock'><p>Determine the class of a status code, based on its first digit.</p>
|
||
</div><h4 id='method.is_informational' class='method'><code>fn <a href='#method.is_informational' class='fnname'>is_informational</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is Informational.</p>
|
||
</div><h4 id='method.is_success' class='method'><code>fn <a href='#method.is_success' class='fnname'>is_success</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is Success.</p>
|
||
</div><h4 id='method.is_redirection' class='method'><code>fn <a href='#method.is_redirection' class='fnname'>is_redirection</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is Redirection.</p>
|
||
</div><h4 id='method.is_client_error' class='method'><code>fn <a href='#method.is_client_error' class='fnname'>is_client_error</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is ClientError.</p>
|
||
</div><h4 id='method.is_server_error' class='method'><code>fn <a href='#method.is_server_error' class='fnname'>is_server_error</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is ServerError.</p>
|
||
</div><h4 id='method.is_strange_status' class='method'><code>fn <a href='#method.is_strange_status' class='fnname'>is_strange_status</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
|
||
<div class='docblock'><p>Check if class is NoClass</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/hash/trait.Hash.html' title='core::hash::Hash'>Hash</a> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.hash' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a><__H>(&self, __arg_0: &mut __H) <span class='where'>where __H: <a class='trait' href='https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html' title='core::hash::Hasher'>Hasher</a></span></code></h4>
|
||
</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='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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.Display.html' title='core::fmt::Display'>Display</a> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='docblock'><p>Formats the status code, <em>including</em> the canonical reason.</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>ImATeapot</span>), <span class='string'>"418 I'm a teapot"</span>);
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>Unregistered</span>(<span class='number'>123</span>)),
|
||
<span class='string'>"123 <unknown status code>"</span>);</pre>
|
||
</div><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/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a><<a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a>> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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, other: &<a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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, other: &Rhs) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></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='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</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/cmp/trait.PartialOrd.html' title='core::cmp::PartialOrd'>PartialOrd</a><<a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a>> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.partial_cmp' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp' class='fnname'>partial_cmp</a>(&self, other: &<a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a>) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<a class='enum' href='https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html' title='core::cmp::Ordering'>Ordering</a>></code></h4>
|
||
</div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.cmp' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp' class='fnname'>cmp</a>(&self, other: &<a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>StatusCode</a>) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html' title='core::cmp::Ordering'>Ordering</a></code></h4>
|
||
</div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../../modifier/trait.Modifier.html' title='modifier::Modifier'>Modifier</a><<a class='struct' href='../../iron/response/struct.Response.html' title='iron::response::Response'>Response</a>> for <a class='enum' href='../../iron/status/enum.Status.html' title='iron::status::Status'>Status</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-623' class='srclink' href='../../src/iron/modifiers.rs.html#156-160' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.modify' class='method'><code>fn <a href='../../modifier/trait.Modifier.html#tymethod.modify' class='fnname'>modify</a>(self, res: &mut <a class='struct' href='../../iron/response/struct.Response.html' title='iron::response::Response'>Response</a>)</code></h4>
|
||
<div class='docblock'><p>Modify <code>F</code> with self.</p>
|
||
</div></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> |