Struct StatusCode 

pub struct StatusCode(/* private fields */);

Available on native only.

An HTTP status code (status-code in RFC 9110 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());

Implementations

impl StatusCode

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

Available on crate feature exception only.

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());

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

Available on crate feature exception only.

Converts a &[u8] to a status code.

pub const fn as_u16(&self) -> u16

Available on crate feature exception only.

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);

pub fn as_str(&self) -> &str

Available on crate feature exception only.

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");

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

Available on crate feature exception only.

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"));

pub fn is_informational(&self) -> bool

Available on crate feature exception only.

Check if status is within 100-199.

pub fn is_success(&self) -> bool

Available on crate feature exception only.

Check if status is within 200-299.

pub fn is_redirection(&self) -> bool

Available on crate feature exception only.

Check if status is within 300-399.

pub fn is_client_error(&self) -> bool

Available on crate feature exception only.

Check if status is within 400-499.

pub fn is_server_error(&self) -> bool

Available on crate feature exception only.

Check if status is within 500-599.

impl StatusCode

pub const CONTINUE: StatusCode

Available on crate feature exception only.

100 Continue [RFC9110, Section 15.2.1]

pub const SWITCHING_PROTOCOLS: StatusCode

Available on crate feature exception only.

101 Switching Protocols [RFC9110, Section 15.2.2]

pub const PROCESSING: StatusCode

Available on crate feature exception only.

102 Processing [RFC2518, Section 10.1]

pub const EARLY_HINTS: StatusCode

Available on crate feature exception only.

103 Early Hints [RFC8297, Section 2]

pub const OK: StatusCode

Available on crate feature exception only.

200 OK [RFC9110, Section 15.3.1]

pub const CREATED: StatusCode

Available on crate feature exception only.

201 Created [RFC9110, Section 15.3.2]

pub const ACCEPTED: StatusCode

Available on crate feature exception only.

202 Accepted [RFC9110, Section 15.3.3]

pub const NON_AUTHORITATIVE_INFORMATION: StatusCode

Available on crate feature exception only.

203 Non-Authoritative Information [RFC9110, Section 15.3.4]

pub const NO_CONTENT: StatusCode

Available on crate feature exception only.

204 No Content [RFC9110, Section 15.3.5]

pub const RESET_CONTENT: StatusCode

Available on crate feature exception only.

205 Reset Content [RFC9110, Section 15.3.6]

pub const PARTIAL_CONTENT: StatusCode

Available on crate feature exception only.

206 Partial Content [RFC9110, Section 15.3.7]

pub const MULTI_STATUS: StatusCode

Available on crate feature exception only.

207 Multi-Status [RFC4918, Section 11.1]

pub const ALREADY_REPORTED: StatusCode

Available on crate feature exception only.

208 Already Reported [RFC5842, Section 7.1]

pub const IM_USED: StatusCode

Available on crate feature exception only.

226 IM Used [RFC3229, Section 10.4.1]

pub const MULTIPLE_CHOICES: StatusCode

Available on crate feature exception only.

300 Multiple Choices [RFC9110, Section 15.4.1]

pub const MOVED_PERMANENTLY: StatusCode

Available on crate feature exception only.

301 Moved Permanently [RFC9110, Section 15.4.2]

pub const FOUND: StatusCode

Available on crate feature exception only.

302 Found [RFC9110, Section 15.4.3]

pub const SEE_OTHER: StatusCode

Available on crate feature exception only.

303 See Other [RFC9110, Section 15.4.4]

pub const NOT_MODIFIED: StatusCode

Available on crate feature exception only.

304 Not Modified [RFC9110, Section 15.4.5]

pub const USE_PROXY: StatusCode

Available on crate feature exception only.

305 Use Proxy [RFC9110, Section 15.4.6]

pub const TEMPORARY_REDIRECT: StatusCode

Available on crate feature exception only.

307 Temporary Redirect [RFC9110, Section 15.4.7]

pub const PERMANENT_REDIRECT: StatusCode

Available on crate feature exception only.

308 Permanent Redirect [RFC9110, Section 15.4.8]

pub const BAD_REQUEST: StatusCode

Available on crate feature exception only.

400 Bad Request [RFC9110, Section 15.5.1]

pub const UNAUTHORIZED: StatusCode

Available on crate feature exception only.

401 Unauthorized [RFC9110, Section 15.5.2]

pub const PAYMENT_REQUIRED: StatusCode

Available on crate feature exception only.

402 Payment Required [RFC9110, Section 15.5.3]

pub const FORBIDDEN: StatusCode

Available on crate feature exception only.

403 Forbidden [RFC9110, Section 15.5.4]

pub const NOT_FOUND: StatusCode

Available on crate feature exception only.

404 Not Found [RFC9110, Section 15.5.5]

pub const METHOD_NOT_ALLOWED: StatusCode

Available on crate feature exception only.

405 Method Not Allowed [RFC9110, Section 15.5.6]

pub const NOT_ACCEPTABLE: StatusCode

Available on crate feature exception only.

406 Not Acceptable [RFC9110, Section 15.5.7]

pub const PROXY_AUTHENTICATION_REQUIRED: StatusCode

Available on crate feature exception only.

407 Proxy Authentication Required [RFC9110, Section 15.5.8]

pub const REQUEST_TIMEOUT: StatusCode

Available on crate feature exception only.

408 Request Timeout [RFC9110, Section 15.5.9]

pub const CONFLICT: StatusCode

Available on crate feature exception only.

409 Conflict [RFC9110, Section 15.5.10]

pub const GONE: StatusCode

Available on crate feature exception only.

410 Gone [RFC9110, Section 15.5.11]

pub const LENGTH_REQUIRED: StatusCode

Available on crate feature exception only.

411 Length Required [RFC9110, Section 15.5.12]

pub const PRECONDITION_FAILED: StatusCode

Available on crate feature exception only.

412 Precondition Failed [RFC9110, Section 15.5.13]

pub const PAYLOAD_TOO_LARGE: StatusCode

Available on crate feature exception only.

413 Payload Too Large [RFC9110, Section 15.5.14]

pub const URI_TOO_LONG: StatusCode

Available on crate feature exception only.

414 URI Too Long [RFC9110, Section 15.5.15]

pub const UNSUPPORTED_MEDIA_TYPE: StatusCode

Available on crate feature exception only.

415 Unsupported Media Type [RFC9110, Section 15.5.16]

pub const RANGE_NOT_SATISFIABLE: StatusCode

Available on crate feature exception only.

416 Range Not Satisfiable [RFC9110, Section 15.5.17]

pub const EXPECTATION_FAILED: StatusCode

Available on crate feature exception only.

417 Expectation Failed [RFC9110, Section 15.5.18]

pub const IM_A_TEAPOT: StatusCode

Available on crate feature exception only.

418 I’m a teapot [curiously not registered by IANA but RFC2324, Section 2.3.2]

pub const MISDIRECTED_REQUEST: StatusCode

Available on crate feature exception only.

421 Misdirected Request [RFC9110, Section 15.5.20]

pub const UNPROCESSABLE_ENTITY: StatusCode

Available on crate feature exception only.

422 Unprocessable Entity [RFC9110, Section 15.5.21]

pub const LOCKED: StatusCode

Available on crate feature exception only.

423 Locked [RFC4918, Section 11.3]

pub const FAILED_DEPENDENCY: StatusCode

Available on crate feature exception only.

424 Failed Dependency [RFC4918, Section 11.4]

pub const TOO_EARLY: StatusCode

Available on crate feature exception only.

425 Too early [RFC8470, Section 5.2]

pub const UPGRADE_REQUIRED: StatusCode

Available on crate feature exception only.

426 Upgrade Required [RFC9110, Section 15.5.22]

pub const PRECONDITION_REQUIRED: StatusCode

Available on crate feature exception only.

428 Precondition Required [RFC6585, Section 3]

pub const TOO_MANY_REQUESTS: StatusCode

Available on crate feature exception only.

429 Too Many Requests [RFC6585, Section 4]

pub const REQUEST_HEADER_FIELDS_TOO_LARGE: StatusCode

Available on crate feature exception only.

431 Request Header Fields Too Large [RFC6585, Section 5]

pub const UNAVAILABLE_FOR_LEGAL_REASONS: StatusCode

Available on crate feature exception only.

451 Unavailable For Legal Reasons [RFC7725, Section 3]

pub const INTERNAL_SERVER_ERROR: StatusCode

Available on crate feature exception only.

500 Internal Server Error [RFC9110, Section 15.6.1]

pub const NOT_IMPLEMENTED: StatusCode

Available on crate feature exception only.

501 Not Implemented [RFC9110, Section 15.6.2]

pub const BAD_GATEWAY: StatusCode

Available on crate feature exception only.

502 Bad Gateway [RFC9110, Section 15.6.3]

pub const SERVICE_UNAVAILABLE: StatusCode

Available on crate feature exception only.

503 Service Unavailable [RFC9110, Section 15.6.4]

pub const GATEWAY_TIMEOUT: StatusCode

Available on crate feature exception only.

504 Gateway Timeout [RFC9110, Section 15.6.5]

pub const HTTP_VERSION_NOT_SUPPORTED: StatusCode

Available on crate feature exception only.

505 HTTP Version Not Supported [RFC9110, Section 15.6.6]

pub const VARIANT_ALSO_NEGOTIATES: StatusCode

Available on crate feature exception only.

506 Variant Also Negotiates [RFC2295, Section 8.1]

pub const INSUFFICIENT_STORAGE: StatusCode

Available on crate feature exception only.

507 Insufficient Storage [RFC4918, Section 11.5]

pub const LOOP_DETECTED: StatusCode

Available on crate feature exception only.

508 Loop Detected [RFC5842, Section 7.2]

pub const NOT_EXTENDED: StatusCode

Available on crate feature exception only.

510 Not Extended [RFC2774, Section 7]

pub const NETWORK_AUTHENTICATION_REQUIRED: StatusCode

Available on crate feature exception only.

511 Network Authentication Required [RFC6585, Section 6]

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for StatusCode

impl Debug for StatusCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for StatusCode

fn default() -> StatusCode

Returns the “default value” for a type.

impl Display for StatusCode

Formats the status code, including the canonical reason.

Example

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for StatusCode

impl From<&StatusCode> for StatusCode

fn from(t: &StatusCode) -> StatusCode

Converts to this type from the input type.

impl From<StatusCode> for StatusCode

Available on crate feature http-1x only.

fn from(value: StatusCode) -> StatusCode

Converts to this type from the input type.

impl FromStr for StatusCode

type Err = InvalidStatusCode

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<StatusCode, InvalidStatusCode>

Parses a string s to return a value of this type.

impl Hash for StatusCode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoResponse for StatusCode

fn into_response(self) -> Response<Body>

Create a response.

impl IntoResponse for StatusCode

fn into_response(self) -> Response

Convert self into an HTTP response

impl Ord for StatusCode

fn cmp(&self, other: &StatusCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StatusCode

fn eq(&self, other: &StatusCode) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u16> for StatusCode

fn eq(&self, other: &u16) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StatusCode

fn partial_cmp(&self, other: &StatusCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for StatusCode

impl TryFrom<&[u8]> for StatusCode

type Error = InvalidStatusCode

The type returned in the event of a conversion error.

fn try_from( t: &[u8], ) -> Result<StatusCode, <StatusCode as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&str> for StatusCode

type Error = InvalidStatusCode

The type returned in the event of a conversion error.

fn try_from(t: &str) -> Result<StatusCode, <StatusCode as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<u16> for StatusCode

type Error = InvalidStatusCode

The type returned in the event of a conversion error.

fn try_from(t: u16) -> Result<StatusCode, <StatusCode as TryFrom<u16>>::Error>

Performs the conversion.