Struct rocket::http::Status

pub struct Status {
    pub code: u16,
    pub reason: &'static str,
}

Structure representing an HTTP status: an integer code and a reason phrase.

Usage

Status classes should rarely be created directly. Instead, an associated constant should be used; one is declared for every standard status defined in the HTTP standard.

Example

A status of 200 OK can be instantiated via the Ok constant:

use rocket::http::Status;

let ok = Status::Ok;

A status of 404 Not Found can be instantiated via the NotFound constant:

use rocket::http::Status;

let not_found = Status::NotFound;

The code and phrase can be retrieved directly:

use rocket::http::Status;

let not_found = Status::NotFound;

assert_eq!(not_found.code, 404);
assert_eq!(not_found.reason, "Not Found");
assert_eq!(not_found.to_string(), "404 Not Found".to_string());

Fields

code: u16

The HTTP status code associated with this status.

reason: &'static str

The HTTP reason phrase associated with this status.

Methods

impl Status

const fn new(code: u16, reason: &'static str) -> Status

Creates a new Status with code and reason. This should be only to construct non-standard HTTP statuses. Use an associated constant for standard statuses.

Example

Create a custom 299 Somewhat Successful status:

use rocket::http::Status;

let custom = Status::new(299, "Somewhat Successful");
assert_eq!(custom.to_string(), "299 Somewhat Successful".to_string());

fn class(&self) -> StatusClass

Returns the class of a given status.

Example

use rocket::http::{Status, StatusClass};

let processing = Status::Processing;
assert_eq!(processing.class(), StatusClass::Informational);

let ok = Status::Ok;
assert_eq!(ok.class(), StatusClass::Success);

let see_other = Status::SeeOther;
assert_eq!(see_other.class(), StatusClass::Redirection);

let not_found = Status::NotFound;
assert_eq!(not_found.class(), StatusClass::ClientError);

let internal_error = Status::InternalServerError;
assert_eq!(internal_error.class(), StatusClass::ServerError);

let custom = Status::new(600, "Bizarre");
assert_eq!(custom.class(), StatusClass::Unknown);

const Continue: Status

Continue: Status = <Status>::new(100, "Continue")

Status with code 100 and reason Continue .

const SwitchingProtocols: Status

SwitchingProtocols: Status = <Status>::new(101, "Switching Protocols")

Status with code 101 and reason Switching Protocols .

const Processing: Status

Processing: Status = <Status>::new(102, "Processing")

Status with code 102 and reason Processing .

const Ok: Status

Ok: Status = <Status>::new(200, "OK")

Status with code 200 and reason OK .

const Created: Status

Created: Status = <Status>::new(201, "Created")

Status with code 201 and reason Created .

const Accepted: Status

Accepted: Status = <Status>::new(202, "Accepted")

Status with code 202 and reason Accepted .

const NonAuthoritativeInformation: Status

NonAuthoritativeInformation: Status = <Status>::new(203, "Non-Authoritative Information")

Status with code 203 and reason Non-Authoritative Information .

const NoContent: Status

NoContent: Status = <Status>::new(204, "No Content")

Status with code 204 and reason No Content .

const ResetContent: Status

ResetContent: Status = <Status>::new(205, "Reset Content")

Status with code 205 and reason Reset Content .

const PartialContent: Status

PartialContent: Status = <Status>::new(206, "Partial Content")

Status with code 206 and reason Partial Content .

const MultiStatus: Status

MultiStatus: Status = <Status>::new(207, "Multi-Status")

Status with code 207 and reason Multi-Status .

const AlreadyReported: Status

AlreadyReported: Status = <Status>::new(208, "Already Reported")

Status with code 208 and reason Already Reported .

const ImUsed: Status

ImUsed: Status = <Status>::new(226, "IM Used")

Status with code 226 and reason IM Used .

const MultipleChoices: Status

MultipleChoices: Status = <Status>::new(300, "Multiple Choices")

Status with code 300 and reason Multiple Choices .

const MovedPermanently: Status

MovedPermanently: Status = <Status>::new(301, "Moved Permanently")

Status with code 301 and reason Moved Permanently .

const Found: Status

Found: Status = <Status>::new(302, "Found")

Status with code 302 and reason Found .

const SeeOther: Status

SeeOther: Status = <Status>::new(303, "See Other")

Status with code 303 and reason See Other .

const NotModified: Status

NotModified: Status = <Status>::new(304, "Not Modified")

Status with code 304 and reason Not Modified .

const UseProxy: Status

UseProxy: Status = <Status>::new(305, "Use Proxy")

Status with code 305 and reason Use Proxy .

const TemporaryRedirect: Status

TemporaryRedirect: Status = <Status>::new(307, "Temporary Redirect")

Status with code 307 and reason Temporary Redirect .

const PermanentRedirect: Status

PermanentRedirect: Status = <Status>::new(308, "Permanent Redirect")

Status with code 308 and reason Permanent Redirect .

const BadRequest: Status

BadRequest: Status = <Status>::new(400, "Bad Request")

Status with code 400 and reason Bad Request .

const Unauthorized: Status

Unauthorized: Status = <Status>::new(401, "Unauthorized")

Status with code 401 and reason Unauthorized .

const PaymentRequired: Status

PaymentRequired: Status = <Status>::new(402, "Payment Required")

Status with code 402 and reason Payment Required .

const Forbidden: Status

Forbidden: Status = <Status>::new(403, "Forbidden")

Status with code 403 and reason Forbidden .

const NotFound: Status

NotFound: Status = <Status>::new(404, "Not Found")

Status with code 404 and reason Not Found .

const MethodNotAllowed: Status

MethodNotAllowed: Status = <Status>::new(405, "Method Not Allowed")

Status with code 405 and reason Method Not Allowed .

const NotAcceptable: Status

NotAcceptable: Status = <Status>::new(406, "Not Acceptable")

Status with code 406 and reason Not Acceptable .

const ProxyAuthenticationRequired: Status

ProxyAuthenticationRequired: Status = <Status>::new(407, "Proxy Authentication Required")

Status with code 407 and reason Proxy Authentication Required .

const RequestTimeout: Status

RequestTimeout: Status = <Status>::new(408, "Request Timeout")

Status with code 408 and reason Request Timeout .

const Conflict: Status

Conflict: Status = <Status>::new(409, "Conflict")

Status with code 409 and reason Conflict .

const Gone: Status

Gone: Status = <Status>::new(410, "Gone")

Status with code 410 and reason Gone .

const LengthRequired: Status

LengthRequired: Status = <Status>::new(411, "Length Required")

Status with code 411 and reason Length Required .

const PreconditionFailed: Status

PreconditionFailed: Status = <Status>::new(412, "Precondition Failed")

Status with code 412 and reason Precondition Failed .

const PayloadTooLarge: Status

PayloadTooLarge: Status = <Status>::new(413, "Payload Too Large")

Status with code 413 and reason Payload Too Large .

const UriTooLong: Status

UriTooLong: Status = <Status>::new(414, "URI Too Long")

Status with code 414 and reason URI Too Long .

const UnsupportedMediaType: Status

UnsupportedMediaType: Status = <Status>::new(415, "Unsupported Media Type")

Status with code 415 and reason Unsupported Media Type .

const RangeNotSatisfiable: Status

RangeNotSatisfiable: Status = <Status>::new(416, "Range Not Satisfiable")

Status with code 416 and reason Range Not Satisfiable .

const ExpectationFailed: Status

ExpectationFailed: Status = <Status>::new(417, "Expectation Failed")

Status with code 417 and reason Expectation Failed .

const ImATeapot: Status

ImATeapot: Status = <Status>::new(418, "I\'m a teapot")

Status with code 418 and reason I'm a teapot .

const MisdirectedRequest: Status

MisdirectedRequest: Status = <Status>::new(421, "Misdirected Request")

Status with code 421 and reason Misdirected Request .

const UnprocessableEntity: Status

UnprocessableEntity: Status = <Status>::new(422, "Unprocessable Entity")

Status with code 422 and reason Unprocessable Entity .

const Locked: Status

Locked: Status = <Status>::new(423, "Locked")

Status with code 423 and reason Locked .

const FailedDependency: Status

FailedDependency: Status = <Status>::new(424, "Failed Dependency")

Status with code 424 and reason Failed Dependency .

const UpgradeRequired: Status

UpgradeRequired: Status = <Status>::new(426, "Upgrade Required")

Status with code 426 and reason Upgrade Required .

const PreconditionRequired: Status

PreconditionRequired: Status = <Status>::new(428, "Precondition Required")

Status with code 428 and reason Precondition Required .

const TooManyRequests: Status

TooManyRequests: Status = <Status>::new(429, "Too Many Requests")

Status with code 429 and reason Too Many Requests .

const RequestHeaderFieldsTooLarge: Status

RequestHeaderFieldsTooLarge: Status = <Status>::new(431, "Request Header Fields Too Large")

Status with code 431 and reason Request Header Fields Too Large .

const UnavailableForLegalReasons: Status

UnavailableForLegalReasons: Status = <Status>::new(451, "Unavailable For Legal Reasons")

Status with code 451 and reason Unavailable For Legal Reasons .

const InternalServerError: Status

InternalServerError: Status = <Status>::new(500, "Internal Server Error")

Status with code 500 and reason Internal Server Error .

const NotImplemented: Status

NotImplemented: Status = <Status>::new(501, "Not Implemented")

Status with code 501 and reason Not Implemented .

const BadGateway: Status

BadGateway: Status = <Status>::new(502, "Bad Gateway")

Status with code 502 and reason Bad Gateway .

const ServiceUnavailable: Status

ServiceUnavailable: Status = <Status>::new(503, "Service Unavailable")

Status with code 503 and reason Service Unavailable .

const GatewayTimeout: Status

GatewayTimeout: Status = <Status>::new(504, "Gateway Timeout")

Status with code 504 and reason Gateway Timeout .

const HttpVersionNotSupported: Status

HttpVersionNotSupported: Status = <Status>::new(505, "HTTP Version Not Supported")

Status with code 505 and reason HTTP Version Not Supported .

const VariantAlsoNegotiates: Status

VariantAlsoNegotiates: Status = <Status>::new(506, "Variant Also Negotiates")

Status with code 506 and reason Variant Also Negotiates .

const InsufficientStorage: Status

InsufficientStorage: Status = <Status>::new(507, "Insufficient Storage")

Status with code 507 and reason Insufficient Storage .

const LoopDetected: Status

LoopDetected: Status = <Status>::new(508, "Loop Detected")

Status with code 508 and reason Loop Detected .

const NotExtended: Status

NotExtended: Status = <Status>::new(510, "Not Extended")

Status with code 510 and reason Not Extended .

const NetworkAuthenticationRequired: Status

NetworkAuthenticationRequired: Status = <Status>::new(511, "Network Authentication Required")

Status with code 511 and reason Network Authentication Required .

fn from_code(code: u16) -> Option<Status>

Returns a Status given a standard status code code. If code is not a known status code, None is returned.

Example

Create a Status from a known code:

use rocket::http::Status;

let not_found = Status::from_code(404);
assert_eq!(not_found, Some(Status::NotFound));

Create a Status from an unknown code:

use rocket::http::Status;

let not_found = Status::from_code(600);
assert!(not_found.is_none());

Trait Implementations

impl Debug for Status

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Status

impl Hash for Status

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

Feeds this value into the given [Hasher].

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

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

impl PartialEq for Status

fn eq(&self, __arg_0: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Status) -> bool

This method tests for !=.

impl Eq for Status

impl Display for Status

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.