[][src]Struct hyper::StatusCode

pub struct StatusCode(_);

An HTTP status code (status-code in RFC 7230 et al.).

This type contains constants for all common status codes. It allows status codes in the range [100, 599].

IANA maintain the Hypertext Transfer Protocol (HTTP) Status Code Registry which is the source for this enum (with one exception, 418 I'm a teapot, which is inexplicably not in the register).


use http::StatusCode;

assert_eq!(StatusCode::from_u16(200).unwrap(), StatusCode::OK);
assert_eq!(StatusCode::NOT_FOUND.as_u16(), 404);


impl StatusCode[src]

pub fn from_u16(src: u16) -> Result<StatusCode, InvalidStatusCode>[src]

Converts a u16 to a status code.

The function validates the correctness of the supplied u16. It must be greater or equal to 100 but less than 600.


use http::StatusCode;

let ok = StatusCode::from_u16(200).unwrap();
assert_eq!(ok, StatusCode::OK);

let err = StatusCode::from_u16(99);

pub fn from_bytes(src: &[u8]) -> Result<StatusCode, InvalidStatusCode>[src]

Converts a &u8 to a status code

pub fn as_u16(&self) -> u16[src]

Returns the u16 corresponding to this StatusCode.


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.


let status = http::StatusCode::OK;
assert_eq!(status.as_u16(), 200);

pub fn as_str(&self) -> &str[src]

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.


let status = http::StatusCode::OK;
assert_eq!(status.as_str(), "200");

pub fn canonical_reason(&self) -> Option<&'static str>[src]

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 the reason phrase is abolished from transmission, and so this canonical reason phrase really is the only reason phrase you’ll find.


let status = http::StatusCode::OK;
assert_eq!(status.canonical_reason(), Some("OK"));

pub fn is_informational(&self) -> bool[src]

Check if status is within 100-199.

pub fn is_success(&self) -> bool[src]

Check if status is within 200-299.

pub fn is_redirection(&self) -> bool[src]

Check if status is within 300-399.

pub fn is_client_error(&self) -> bool[src]

Check if status is within 400-499.

pub fn is_server_error(&self) -> bool[src]

Check if status is within 500-599.

impl StatusCode[src]

pub const CONTINUE: StatusCode[src]

100 Continue [RFC7231, Section 6.2.1]

pub const SWITCHING_PROTOCOLS: StatusCode[src]

101 Switching Protocols [RFC7231, Section 6.2.2]

pub const PROCESSING: StatusCode[src]

102 Processing [RFC2518]

pub const OK: StatusCode[src]

pub const CREATED: StatusCode[src]

201 Created [RFC7231, Section 6.3.2]

pub const ACCEPTED: StatusCode[src]

202 Accepted [RFC7231, Section 6.3.3]


203 Non-Authoritative Information [RFC7231, Section 6.3.4]

pub const NO_CONTENT: StatusCode[src]

204 No Content [RFC7231, Section 6.3.5]

pub const RESET_CONTENT: StatusCode[src]

205 Reset Content [RFC7231, Section 6.3.6]

pub const PARTIAL_CONTENT: StatusCode[src]

206 Partial Content [RFC7233, Section 4.1]

pub const MULTI_STATUS: StatusCode[src]

207 Multi-Status [RFC4918]

pub const ALREADY_REPORTED: StatusCode[src]

208 Already Reported [RFC5842]

pub const IM_USED: StatusCode[src]

226 IM Used [RFC3229]

pub const MULTIPLE_CHOICES: StatusCode[src]

300 Multiple Choices [RFC7231, Section 6.4.1]

pub const MOVED_PERMANENTLY: StatusCode[src]

301 Moved Permanently [RFC7231, Section 6.4.2]

pub const FOUND: StatusCode[src]

pub const SEE_OTHER: StatusCode[src]

303 See Other [RFC7231, Section 6.4.4]

pub const NOT_MODIFIED: StatusCode[src]

304 Not Modified [RFC7232, Section 4.1]

pub const USE_PROXY: StatusCode[src]

305 Use Proxy [RFC7231, Section 6.4.5]

pub const TEMPORARY_REDIRECT: StatusCode[src]

307 Temporary Redirect [RFC7231, Section 6.4.7]

pub const PERMANENT_REDIRECT: StatusCode[src]

308 Permanent Redirect [RFC7238]

pub const BAD_REQUEST: StatusCode[src]

400 Bad Request [RFC7231, Section 6.5.1]

pub const UNAUTHORIZED: StatusCode[src]

401 Unauthorized [RFC7235, Section 3.1]

pub const PAYMENT_REQUIRED: StatusCode[src]

402 Payment Required [RFC7231, Section 6.5.2]

pub const FORBIDDEN: StatusCode[src]

403 Forbidden [RFC7231, Section 6.5.3]

pub const NOT_FOUND: StatusCode[src]

404 Not Found [RFC7231, Section 6.5.4]

pub const METHOD_NOT_ALLOWED: StatusCode[src]

405 Method Not Allowed [RFC7231, Section 6.5.5]

pub const NOT_ACCEPTABLE: StatusCode[src]

406 Not Acceptable [RFC7231, Section 6.5.6]


407 Proxy Authentication Required [RFC7235, Section 3.2]

pub const REQUEST_TIMEOUT: StatusCode[src]

408 Request Timeout [RFC7231, Section 6.5.7]

pub const CONFLICT: StatusCode[src]

409 Conflict [RFC7231, Section 6.5.8]

pub const GONE: StatusCode[src]

pub const LENGTH_REQUIRED: StatusCode[src]

411 Length Required [RFC7231, Section 6.5.10]

pub const PRECONDITION_FAILED: StatusCode[src]

412 Precondition Failed [RFC7232, Section 4.2]

pub const PAYLOAD_TOO_LARGE: StatusCode[src]

413 Payload Too Large [RFC7231, Section 6.5.11]

pub const URI_TOO_LONG: StatusCode[src]

414 URI Too Long [RFC7231, Section 6.5.12]

pub const UNSUPPORTED_MEDIA_TYPE: StatusCode[src]

415 Unsupported Media Type [RFC7231, Section 6.5.13]

pub const RANGE_NOT_SATISFIABLE: StatusCode[src]

416 Range Not Satisfiable [RFC7233, Section 4.4]

pub const EXPECTATION_FAILED: StatusCode[src]

417 Expectation Failed [RFC7231, Section 6.5.14]

pub const IM_A_TEAPOT: StatusCode[src]

418 I'm a teapot [curiously not registered by IANA but RFC2324]

pub const MISDIRECTED_REQUEST: StatusCode[src]

421 Misdirected Request RFC7540, Section 9.1.2

pub const UNPROCESSABLE_ENTITY: StatusCode[src]

422 Unprocessable Entity [RFC4918]

pub const LOCKED: StatusCode[src]

423 Locked [RFC4918]

pub const FAILED_DEPENDENCY: StatusCode[src]

424 Failed Dependency [RFC4918]

pub const UPGRADE_REQUIRED: StatusCode[src]

426 Upgrade Required [RFC7231, Section 6.5.15]

pub const PRECONDITION_REQUIRED: StatusCode[src]

428 Precondition Required [RFC6585]

pub const TOO_MANY_REQUESTS: StatusCode[src]

429 Too Many Requests [RFC6585]

pub const REQUEST_HEADER_FIELDS_TOO_LARGE: StatusCode[src]

431 Request Header Fields Too Large [RFC6585]

451 Unavailable For Legal Reasons [RFC7725]

pub const INTERNAL_SERVER_ERROR: StatusCode[src]

500 Internal Server Error [RFC7231, Section 6.6.1]

pub const NOT_IMPLEMENTED: StatusCode[src]

501 Not Implemented [RFC7231, Section 6.6.2]

pub const BAD_GATEWAY: StatusCode[src]

502 Bad Gateway [RFC7231, Section 6.6.3]

pub const SERVICE_UNAVAILABLE: StatusCode[src]

503 Service Unavailable [RFC7231, Section 6.6.4]

pub const GATEWAY_TIMEOUT: StatusCode[src]

504 Gateway Timeout [RFC7231, Section 6.6.5]

pub const HTTP_VERSION_NOT_SUPPORTED: StatusCode[src]

505 HTTP Version Not Supported [RFC7231, Section 6.6.6]

pub const VARIANT_ALSO_NEGOTIATES: StatusCode[src]

506 Variant Also Negotiates [RFC2295]

pub const INSUFFICIENT_STORAGE: StatusCode[src]

507 Insufficient Storage [RFC4918]

pub const LOOP_DETECTED: StatusCode[src]

508 Loop Detected [RFC5842]

pub const NOT_EXTENDED: StatusCode[src]

510 Not Extended [RFC2774]


511 Network Authentication Required [RFC6585]

Trait Implementations

impl Debug for StatusCode[src]

impl<'a> From<&'a StatusCode> for StatusCode[src]

impl PartialOrd<StatusCode> for StatusCode[src]

impl Eq for StatusCode[src]

impl Default for StatusCode[src]

impl Copy for StatusCode[src]

impl Ord for StatusCode[src]

fn max(self, other: Self) -> Self1.21.0[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self1.21.0[src]

Compares and returns the minimum of two values. Read more

fn clamp(self, min: Self, max: Self) -> Self[src]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval. Read more

impl PartialEq<u16> for StatusCode[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<StatusCode> for StatusCode[src]

impl Display for StatusCode[src]

Formats the status code, including the canonical reason.


assert_eq!(format!("{}", StatusCode::OK), "200 OK");

impl HttpTryFrom<u16> for StatusCode[src]

type Error = InvalidStatusCode

Associated error with the conversion this implementation represents.

impl<'a> HttpTryFrom<&'a [u8]> for StatusCode[src]

type Error = InvalidStatusCode

Associated error with the conversion this implementation represents.

impl<'a> HttpTryFrom<&'a str> for StatusCode[src]

type Error = InvalidStatusCode

Associated error with the conversion this implementation represents.

impl HttpTryFrom<StatusCode> for StatusCode[src]

type Error = Error

Associated error with the conversion this implementation represents.

impl<'a> HttpTryFrom<&'a StatusCode> for StatusCode[src]

type Error = Never

Associated error with the conversion this implementation represents.

impl FromStr for StatusCode[src]

type Err = InvalidStatusCode

The associated error which can be returned from parsing.

impl Clone for StatusCode[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Hash for StatusCode[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher

Feeds a slice of this type into the given [Hasher]. Read more

Auto Trait Implementations

impl Send for StatusCode

impl Sync for StatusCode

Blanket Implementations

impl<T> ToString for T where
    T: Display + ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized

impl<T> Erased for T