Struct hyper::StatusCode
source · pub struct StatusCode(NonZero<u16>);
Expand description
An HTTP status code (status-code
in RFC 7230 et al.).
Constants are provided for known status codes, including those in the IANA HTTP Status Code Registry.
Status code values in the range 100-999 (inclusive) are supported by this
type. Values in the range 100-599 are semantically classified by the most
significant digit. See StatusCode::is_success
, etc. Values above 599
are unclassified but allowed for legacy compatibility, though their use is
discouraged. Applications may interpret such values as protocol errors.
§Examples
use http::StatusCode;
assert_eq!(StatusCode::from_u16(200).unwrap(), StatusCode::OK);
assert_eq!(StatusCode::NOT_FOUND.as_u16(), 404);
assert!(StatusCode::OK.is_success());
Tuple Fields§
§0: NonZero<u16>
Implementations§
source§impl StatusCode
impl StatusCode
sourcepub fn from_u16(src: u16) -> Result<StatusCode, InvalidStatusCode>
pub fn from_u16(src: u16) -> Result<StatusCode, InvalidStatusCode>
Converts a u16 to a status code.
The function validates the correctness of the supplied u16. It must be greater or equal to 100 and less than 1000.
§Example
use http::StatusCode;
let ok = StatusCode::from_u16(200).unwrap();
assert_eq!(ok, StatusCode::OK);
let err = StatusCode::from_u16(99);
assert!(err.is_err());
sourcepub fn from_bytes(src: &[u8]) -> Result<StatusCode, InvalidStatusCode>
pub fn from_bytes(src: &[u8]) -> Result<StatusCode, InvalidStatusCode>
Converts a &u8 to a status code
sourcepub fn as_u16(&self) -> u16
pub fn as_u16(&self) -> u16
Returns the u16
corresponding to this StatusCode
.
§Note
This is the same as the From<StatusCode>
implementation, but
included as an inherent method because that implementation doesn’t
appear in rustdocs, as well as a way to force the type instead of
relying on inference.
§Example
let status = http::StatusCode::OK;
assert_eq!(status.as_u16(), 200);
sourcepub fn as_str(&self) -> &str
pub fn as_str(&self) -> &str
Returns a &str representation of the StatusCode
The return value only includes a numerical representation of the status code. The canonical reason is not included.
§Example
let status = http::StatusCode::OK;
assert_eq!(status.as_str(), "200");
sourcepub fn canonical_reason(&self) -> Option<&'static str>
pub fn canonical_reason(&self) -> Option<&'static str>
Get the standardised reason-phrase
for this status code.
This is mostly here for servers writing responses, but could potentially have application at other times.
The reason phrase is defined as being exclusively for human readers. You should avoid deriving any meaning from it at all costs.
Bear in mind also that in HTTP/2.0 and HTTP/3.0 the reason phrase is abolished from transmission, and so this canonical reason phrase really is the only reason phrase you’ll find.
§Example
let status = http::StatusCode::OK;
assert_eq!(status.canonical_reason(), Some("OK"));
sourcepub fn is_informational(&self) -> bool
pub fn is_informational(&self) -> bool
Check if status is within 100-199.
sourcepub fn is_success(&self) -> bool
pub fn is_success(&self) -> bool
Check if status is within 200-299.
sourcepub fn is_redirection(&self) -> bool
pub fn is_redirection(&self) -> bool
Check if status is within 300-399.
sourcepub fn is_client_error(&self) -> bool
pub fn is_client_error(&self) -> bool
Check if status is within 400-499.
sourcepub fn is_server_error(&self) -> bool
pub fn is_server_error(&self) -> bool
Check if status is within 500-599.
source§impl StatusCode
impl StatusCode
sourcepub const CONTINUE: StatusCode = _
pub const CONTINUE: StatusCode = _
100 Continue [RFC7231, Section 6.2.1]
sourcepub const SWITCHING_PROTOCOLS: StatusCode = _
pub const SWITCHING_PROTOCOLS: StatusCode = _
101 Switching Protocols [RFC7231, Section 6.2.2]
sourcepub const PROCESSING: StatusCode = _
pub const PROCESSING: StatusCode = _
102 Processing [RFC2518]
sourcepub const OK: StatusCode = _
pub const OK: StatusCode = _
200 OK [RFC7231, Section 6.3.1]
sourcepub const CREATED: StatusCode = _
pub const CREATED: StatusCode = _
201 Created [RFC7231, Section 6.3.2]
sourcepub const ACCEPTED: StatusCode = _
pub const ACCEPTED: StatusCode = _
202 Accepted [RFC7231, Section 6.3.3]
sourcepub const NON_AUTHORITATIVE_INFORMATION: StatusCode = _
pub const NON_AUTHORITATIVE_INFORMATION: StatusCode = _
203 Non-Authoritative Information [RFC7231, Section 6.3.4]
sourcepub const NO_CONTENT: StatusCode = _
pub const NO_CONTENT: StatusCode = _
204 No Content [RFC7231, Section 6.3.5]
sourcepub const RESET_CONTENT: StatusCode = _
pub const RESET_CONTENT: StatusCode = _
205 Reset Content [RFC7231, Section 6.3.6]
sourcepub const PARTIAL_CONTENT: StatusCode = _
pub const PARTIAL_CONTENT: StatusCode = _
206 Partial Content [RFC7233, Section 4.1]
sourcepub const MULTI_STATUS: StatusCode = _
pub const MULTI_STATUS: StatusCode = _
207 Multi-Status [RFC4918]
sourcepub const ALREADY_REPORTED: StatusCode = _
pub const ALREADY_REPORTED: StatusCode = _
208 Already Reported [RFC5842]
sourcepub const IM_USED: StatusCode = _
pub const IM_USED: StatusCode = _
226 IM Used [RFC3229]
sourcepub const MULTIPLE_CHOICES: StatusCode = _
pub const MULTIPLE_CHOICES: StatusCode = _
300 Multiple Choices [RFC7231, Section 6.4.1]
sourcepub const MOVED_PERMANENTLY: StatusCode = _
pub const MOVED_PERMANENTLY: StatusCode = _
301 Moved Permanently [RFC7231, Section 6.4.2]
sourcepub const FOUND: StatusCode = _
pub const FOUND: StatusCode = _
302 Found [RFC7231, Section 6.4.3]
sourcepub const SEE_OTHER: StatusCode = _
pub const SEE_OTHER: StatusCode = _
303 See Other [RFC7231, Section 6.4.4]
sourcepub const NOT_MODIFIED: StatusCode = _
pub const NOT_MODIFIED: StatusCode = _
304 Not Modified [RFC7232, Section 4.1]
sourcepub const USE_PROXY: StatusCode = _
pub const USE_PROXY: StatusCode = _
305 Use Proxy [RFC7231, Section 6.4.5]
sourcepub const TEMPORARY_REDIRECT: StatusCode = _
pub const TEMPORARY_REDIRECT: StatusCode = _
307 Temporary Redirect [RFC7231, Section 6.4.7]
sourcepub const PERMANENT_REDIRECT: StatusCode = _
pub const PERMANENT_REDIRECT: StatusCode = _
308 Permanent Redirect [RFC7238]
sourcepub const BAD_REQUEST: StatusCode = _
pub const BAD_REQUEST: StatusCode = _
400 Bad Request [RFC7231, Section 6.5.1]
sourcepub const UNAUTHORIZED: StatusCode = _
pub const UNAUTHORIZED: StatusCode = _
401 Unauthorized [RFC7235, Section 3.1]
sourcepub const PAYMENT_REQUIRED: StatusCode = _
pub const PAYMENT_REQUIRED: StatusCode = _
402 Payment Required [RFC7231, Section 6.5.2]
sourcepub const FORBIDDEN: StatusCode = _
pub const FORBIDDEN: StatusCode = _
403 Forbidden [RFC7231, Section 6.5.3]
sourcepub const NOT_FOUND: StatusCode = _
pub const NOT_FOUND: StatusCode = _
404 Not Found [RFC7231, Section 6.5.4]
sourcepub const METHOD_NOT_ALLOWED: StatusCode = _
pub const METHOD_NOT_ALLOWED: StatusCode = _
405 Method Not Allowed [RFC7231, Section 6.5.5]
sourcepub const NOT_ACCEPTABLE: StatusCode = _
pub const NOT_ACCEPTABLE: StatusCode = _
406 Not Acceptable [RFC7231, Section 6.5.6]
sourcepub const PROXY_AUTHENTICATION_REQUIRED: StatusCode = _
pub const PROXY_AUTHENTICATION_REQUIRED: StatusCode = _
407 Proxy Authentication Required [RFC7235, Section 3.2]
sourcepub const REQUEST_TIMEOUT: StatusCode = _
pub const REQUEST_TIMEOUT: StatusCode = _
408 Request Timeout [RFC7231, Section 6.5.7]
sourcepub const CONFLICT: StatusCode = _
pub const CONFLICT: StatusCode = _
409 Conflict [RFC7231, Section 6.5.8]
sourcepub const GONE: StatusCode = _
pub const GONE: StatusCode = _
410 Gone [RFC7231, Section 6.5.9]
sourcepub const LENGTH_REQUIRED: StatusCode = _
pub const LENGTH_REQUIRED: StatusCode = _
411 Length Required [RFC7231, Section 6.5.10]
sourcepub const PRECONDITION_FAILED: StatusCode = _
pub const PRECONDITION_FAILED: StatusCode = _
412 Precondition Failed [RFC7232, Section 4.2]
sourcepub const PAYLOAD_TOO_LARGE: StatusCode = _
pub const PAYLOAD_TOO_LARGE: StatusCode = _
413 Payload Too Large [RFC7231, Section 6.5.11]
sourcepub const URI_TOO_LONG: StatusCode = _
pub const URI_TOO_LONG: StatusCode = _
414 URI Too Long [RFC7231, Section 6.5.12]
sourcepub const UNSUPPORTED_MEDIA_TYPE: StatusCode = _
pub const UNSUPPORTED_MEDIA_TYPE: StatusCode = _
415 Unsupported Media Type [RFC7231, Section 6.5.13]
sourcepub const RANGE_NOT_SATISFIABLE: StatusCode = _
pub const RANGE_NOT_SATISFIABLE: StatusCode = _
416 Range Not Satisfiable [RFC7233, Section 4.4]
sourcepub const EXPECTATION_FAILED: StatusCode = _
pub const EXPECTATION_FAILED: StatusCode = _
417 Expectation Failed [RFC7231, Section 6.5.14]
sourcepub const IM_A_TEAPOT: StatusCode = _
pub const IM_A_TEAPOT: StatusCode = _
418 I’m a teapot [curiously not registered by IANA but RFC2324]
sourcepub const MISDIRECTED_REQUEST: StatusCode = _
pub const MISDIRECTED_REQUEST: StatusCode = _
421 Misdirected Request RFC7540, Section 9.1.2
sourcepub const UNPROCESSABLE_ENTITY: StatusCode = _
pub const UNPROCESSABLE_ENTITY: StatusCode = _
422 Unprocessable Entity [RFC4918]
sourcepub const LOCKED: StatusCode = _
pub const LOCKED: StatusCode = _
423 Locked [RFC4918]
sourcepub const FAILED_DEPENDENCY: StatusCode = _
pub const FAILED_DEPENDENCY: StatusCode = _
424 Failed Dependency [RFC4918]
sourcepub const UPGRADE_REQUIRED: StatusCode = _
pub const UPGRADE_REQUIRED: StatusCode = _
426 Upgrade Required [RFC7231, Section 6.5.15]
sourcepub const PRECONDITION_REQUIRED: StatusCode = _
pub const PRECONDITION_REQUIRED: StatusCode = _
428 Precondition Required [RFC6585]
sourcepub const TOO_MANY_REQUESTS: StatusCode = _
pub const TOO_MANY_REQUESTS: StatusCode = _
429 Too Many Requests [RFC6585]
sourcepub const REQUEST_HEADER_FIELDS_TOO_LARGE: StatusCode = _
pub const REQUEST_HEADER_FIELDS_TOO_LARGE: StatusCode = _
431 Request Header Fields Too Large [RFC6585]
sourcepub const UNAVAILABLE_FOR_LEGAL_REASONS: StatusCode = _
pub const UNAVAILABLE_FOR_LEGAL_REASONS: StatusCode = _
451 Unavailable For Legal Reasons [RFC7725]
sourcepub const INTERNAL_SERVER_ERROR: StatusCode = _
pub const INTERNAL_SERVER_ERROR: StatusCode = _
500 Internal Server Error [RFC7231, Section 6.6.1]
sourcepub const NOT_IMPLEMENTED: StatusCode = _
pub const NOT_IMPLEMENTED: StatusCode = _
501 Not Implemented [RFC7231, Section 6.6.2]
sourcepub const BAD_GATEWAY: StatusCode = _
pub const BAD_GATEWAY: StatusCode = _
502 Bad Gateway [RFC7231, Section 6.6.3]
sourcepub const SERVICE_UNAVAILABLE: StatusCode = _
pub const SERVICE_UNAVAILABLE: StatusCode = _
503 Service Unavailable [RFC7231, Section 6.6.4]
sourcepub const GATEWAY_TIMEOUT: StatusCode = _
pub const GATEWAY_TIMEOUT: StatusCode = _
504 Gateway Timeout [RFC7231, Section 6.6.5]
sourcepub const HTTP_VERSION_NOT_SUPPORTED: StatusCode = _
pub const HTTP_VERSION_NOT_SUPPORTED: StatusCode = _
505 HTTP Version Not Supported [RFC7231, Section 6.6.6]
sourcepub const VARIANT_ALSO_NEGOTIATES: StatusCode = _
pub const VARIANT_ALSO_NEGOTIATES: StatusCode = _
506 Variant Also Negotiates [RFC2295]
sourcepub const INSUFFICIENT_STORAGE: StatusCode = _
pub const INSUFFICIENT_STORAGE: StatusCode = _
507 Insufficient Storage [RFC4918]
sourcepub const LOOP_DETECTED: StatusCode = _
pub const LOOP_DETECTED: StatusCode = _
508 Loop Detected [RFC5842]
sourcepub const NOT_EXTENDED: StatusCode = _
pub const NOT_EXTENDED: StatusCode = _
510 Not Extended [RFC2774]
sourcepub const NETWORK_AUTHENTICATION_REQUIRED: StatusCode = _
pub const NETWORK_AUTHENTICATION_REQUIRED: StatusCode = _
511 Network Authentication Required [RFC6585]
Trait Implementations§
source§impl Clone for StatusCode
impl Clone for StatusCode
source§fn clone(&self) -> StatusCode
fn clone(&self) -> StatusCode
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StatusCode
impl Debug for StatusCode
source§impl Default for StatusCode
impl Default for StatusCode
source§fn default() -> StatusCode
fn default() -> StatusCode
source§impl Display for StatusCode
impl Display for StatusCode
Formats the status code, including the canonical reason.
§Example
assert_eq!(format!("{}", StatusCode::OK), "200 OK");
source§impl<'a> From<&'a StatusCode> for StatusCode
impl<'a> From<&'a StatusCode> for StatusCode
source§fn from(t: &'a StatusCode) -> StatusCode
fn from(t: &'a StatusCode) -> StatusCode
source§impl FromStr for StatusCode
impl FromStr for StatusCode
source§type Err = InvalidStatusCode
type Err = InvalidStatusCode
source§fn from_str(s: &str) -> Result<StatusCode, InvalidStatusCode>
fn from_str(s: &str) -> Result<StatusCode, InvalidStatusCode>
s
to return a value of this type. Read moresource§impl Hash for StatusCode
impl Hash for StatusCode
source§impl Ord for StatusCode
impl Ord for StatusCode
source§fn cmp(&self, other: &StatusCode) -> Ordering
fn cmp(&self, other: &StatusCode) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<u16> for StatusCode
impl PartialEq<u16> for StatusCode
source§impl PartialEq for StatusCode
impl PartialEq for StatusCode
source§impl PartialOrd for StatusCode
impl PartialOrd for StatusCode
source§impl<'a> TryFrom<&'a [u8]> for StatusCode
impl<'a> TryFrom<&'a [u8]> for StatusCode
source§type Error = InvalidStatusCode
type Error = InvalidStatusCode
source§fn try_from(
t: &'a [u8],
) -> Result<StatusCode, <StatusCode as TryFrom<&'a [u8]>>::Error>
fn try_from( t: &'a [u8], ) -> Result<StatusCode, <StatusCode as TryFrom<&'a [u8]>>::Error>
source§impl<'a> TryFrom<&'a str> for StatusCode
impl<'a> TryFrom<&'a str> for StatusCode
source§type Error = InvalidStatusCode
type Error = InvalidStatusCode
source§fn try_from(
t: &'a str,
) -> Result<StatusCode, <StatusCode as TryFrom<&'a str>>::Error>
fn try_from( t: &'a str, ) -> Result<StatusCode, <StatusCode as TryFrom<&'a str>>::Error>
source§impl TryFrom<u16> for StatusCode
impl TryFrom<u16> for StatusCode
source§type Error = InvalidStatusCode
type Error = InvalidStatusCode
source§fn try_from(t: u16) -> Result<StatusCode, <StatusCode as TryFrom<u16>>::Error>
fn try_from(t: u16) -> Result<StatusCode, <StatusCode as TryFrom<u16>>::Error>
impl Copy for StatusCode
impl Eq for StatusCode
impl StructuralPartialEq for StatusCode
Auto Trait Implementations§
impl Freeze for StatusCode
impl RefUnwindSafe for StatusCode
impl Send for StatusCode
impl Sync for StatusCode
impl Unpin for StatusCode
impl UnwindSafe for StatusCode
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.