Struct tauri::http::status::StatusCode

pub struct StatusCode(_);

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

Implementations

impl StatusCode

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

Available on crate feature http-api 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 http-api only.

Converts a &u8 to a status code

pub fn as_u16(&self) -> u16

Available on crate feature http-api 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 http-api 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 http-api 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 http-api only.

Check if status is within 100-199.

pub fn is_success(&self) -> bool

Available on crate feature http-api only.

Check if status is within 200-299.

pub fn is_redirection(&self) -> bool

Available on crate feature http-api only.

Check if status is within 300-399.

pub fn is_client_error(&self) -> bool

Available on crate feature http-api only.

Check if status is within 400-499.

pub fn is_server_error(&self) -> bool

Available on crate feature http-api only.

Check if status is within 500-599.

impl StatusCode

pub const CONTINUE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(100) })

Available on crate feature http-api only.

100 Continue [RFC7231, Section 6.2.1]

pub const SWITCHING_PROTOCOLS: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(101) })

Available on crate feature http-api only.

101 Switching Protocols [RFC7231, Section 6.2.2]

pub const PROCESSING: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(102) })

Available on crate feature http-api only.

102 Processing [RFC2518]

pub const OK: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(200) })

Available on crate feature http-api only.

200 OK [RFC7231, Section 6.3.1]

pub const CREATED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(201) })

Available on crate feature http-api only.

201 Created [RFC7231, Section 6.3.2]

pub const ACCEPTED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(202) })

Available on crate feature http-api only.

202 Accepted [RFC7231, Section 6.3.3]

pub const NON_AUTHORITATIVE_INFORMATION: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(203) })

Available on crate feature http-api only.

203 Non-Authoritative Information [RFC7231, Section 6.3.4]

pub const NO_CONTENT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(204) })

Available on crate feature http-api only.

204 No Content [RFC7231, Section 6.3.5]

pub const RESET_CONTENT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(205) })

Available on crate feature http-api only.

205 Reset Content [RFC7231, Section 6.3.6]

pub const PARTIAL_CONTENT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(206) })

Available on crate feature http-api only.

206 Partial Content [RFC7233, Section 4.1]

pub const MULTI_STATUS: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(207) })

Available on crate feature http-api only.

207 Multi-Status [RFC4918]

pub const ALREADY_REPORTED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(208) })

Available on crate feature http-api only.

208 Already Reported [RFC5842]

pub const IM_USED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(226) })

Available on crate feature http-api only.

226 IM Used [RFC3229]

pub const MULTIPLE_CHOICES: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(300) })

Available on crate feature http-api only.

300 Multiple Choices [RFC7231, Section 6.4.1]

pub const MOVED_PERMANENTLY: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(301) })

Available on crate feature http-api only.

301 Moved Permanently [RFC7231, Section 6.4.2]

pub const FOUND: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(302) })

Available on crate feature http-api only.

302 Found [RFC7231, Section 6.4.3]

pub const SEE_OTHER: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(303) })

Available on crate feature http-api only.

303 See Other [RFC7231, Section 6.4.4]

pub const NOT_MODIFIED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(304) })

Available on crate feature http-api only.

304 Not Modified [RFC7232, Section 4.1]

pub const USE_PROXY: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(305) })

Available on crate feature http-api only.

305 Use Proxy [RFC7231, Section 6.4.5]

pub const TEMPORARY_REDIRECT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(307) })

Available on crate feature http-api only.

307 Temporary Redirect [RFC7231, Section 6.4.7]

pub const PERMANENT_REDIRECT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(308) })

Available on crate feature http-api only.

308 Permanent Redirect [RFC7238]

pub const BAD_REQUEST: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(400) })

Available on crate feature http-api only.

400 Bad Request [RFC7231, Section 6.5.1]

pub const UNAUTHORIZED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(401) })

Available on crate feature http-api only.

401 Unauthorized [RFC7235, Section 3.1]

pub const PAYMENT_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(402) })

Available on crate feature http-api only.

402 Payment Required [RFC7231, Section 6.5.2]

pub const FORBIDDEN: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(403) })

Available on crate feature http-api only.

403 Forbidden [RFC7231, Section 6.5.3]

pub const NOT_FOUND: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(404) })

Available on crate feature http-api only.

404 Not Found [RFC7231, Section 6.5.4]

pub const METHOD_NOT_ALLOWED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(405) })

Available on crate feature http-api only.

405 Method Not Allowed [RFC7231, Section 6.5.5]

pub const NOT_ACCEPTABLE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(406) })

Available on crate feature http-api only.

406 Not Acceptable [RFC7231, Section 6.5.6]

pub const PROXY_AUTHENTICATION_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(407) })

Available on crate feature http-api only.

407 Proxy Authentication Required [RFC7235, Section 3.2]

pub const REQUEST_TIMEOUT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(408) })

Available on crate feature http-api only.

408 Request Timeout [RFC7231, Section 6.5.7]

pub const CONFLICT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(409) })

Available on crate feature http-api only.

409 Conflict [RFC7231, Section 6.5.8]

pub const GONE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(410) })

Available on crate feature http-api only.

410 Gone [RFC7231, Section 6.5.9]

pub const LENGTH_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(411) })

Available on crate feature http-api only.

411 Length Required [RFC7231, Section 6.5.10]

pub const PRECONDITION_FAILED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(412) })

Available on crate feature http-api only.

412 Precondition Failed [RFC7232, Section 4.2]

pub const PAYLOAD_TOO_LARGE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(413) })

Available on crate feature http-api only.

413 Payload Too Large [RFC7231, Section 6.5.11]

pub const URI_TOO_LONG: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(414) })

Available on crate feature http-api only.

414 URI Too Long [RFC7231, Section 6.5.12]

pub const UNSUPPORTED_MEDIA_TYPE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(415) })

Available on crate feature http-api only.

415 Unsupported Media Type [RFC7231, Section 6.5.13]

pub const RANGE_NOT_SATISFIABLE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(416) })

Available on crate feature http-api only.

416 Range Not Satisfiable [RFC7233, Section 4.4]

pub const EXPECTATION_FAILED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(417) })

Available on crate feature http-api only.

417 Expectation Failed [RFC7231, Section 6.5.14]

pub const IM_A_TEAPOT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(418) })

Available on crate feature http-api only.

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

pub const MISDIRECTED_REQUEST: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(421) })

Available on crate feature http-api only.

421 Misdirected Request RFC7540, Section 9.1.2

pub const UNPROCESSABLE_ENTITY: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(422) })

Available on crate feature http-api only.

422 Unprocessable Entity [RFC4918]

pub const LOCKED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(423) })

Available on crate feature http-api only.

423 Locked [RFC4918]

pub const FAILED_DEPENDENCY: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(424) })

Available on crate feature http-api only.

424 Failed Dependency [RFC4918]

pub const UPGRADE_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(426) })

Available on crate feature http-api only.

426 Upgrade Required [RFC7231, Section 6.5.15]

pub const PRECONDITION_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(428) })

Available on crate feature http-api only.

428 Precondition Required [RFC6585]

pub const TOO_MANY_REQUESTS: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(429) })

Available on crate feature http-api only.

429 Too Many Requests [RFC6585]

pub const REQUEST_HEADER_FIELDS_TOO_LARGE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(431) })

Available on crate feature http-api only.

431 Request Header Fields Too Large [RFC6585]

pub const UNAVAILABLE_FOR_LEGAL_REASONS: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(451) })

Available on crate feature http-api only.

451 Unavailable For Legal Reasons [RFC7725]

pub const INTERNAL_SERVER_ERROR: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(500) })

Available on crate feature http-api only.

500 Internal Server Error [RFC7231, Section 6.6.1]

pub const NOT_IMPLEMENTED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(501) })

Available on crate feature http-api only.

501 Not Implemented [RFC7231, Section 6.6.2]

pub const BAD_GATEWAY: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(502) })

Available on crate feature http-api only.

502 Bad Gateway [RFC7231, Section 6.6.3]

pub const SERVICE_UNAVAILABLE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(503) })

Available on crate feature http-api only.

503 Service Unavailable [RFC7231, Section 6.6.4]

pub const GATEWAY_TIMEOUT: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(504) })

Available on crate feature http-api only.

504 Gateway Timeout [RFC7231, Section 6.6.5]

pub const HTTP_VERSION_NOT_SUPPORTED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(505) })

Available on crate feature http-api only.

505 HTTP Version Not Supported [RFC7231, Section 6.6.6]

pub const VARIANT_ALSO_NEGOTIATES: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(506) })

Available on crate feature http-api only.

506 Variant Also Negotiates [RFC2295]

pub const INSUFFICIENT_STORAGE: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(507) })

Available on crate feature http-api only.

507 Insufficient Storage [RFC4918]

pub const LOOP_DETECTED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(508) })

Available on crate feature http-api only.

508 Loop Detected [RFC5842]

pub const NOT_EXTENDED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(510) })

Available on crate feature http-api only.

510 Not Extended [RFC2774]

pub const NETWORK_AUTHENTICATION_REQUIRED: StatusCode = StatusCode(unsafe { NonZeroU16::new_unchecked(511) })

Available on crate feature http-api only.

511 Network Authentication Required [RFC6585]

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a copy of the value.

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

Performs copy-assignment from source.

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<'a> From<&'a StatusCode> for StatusCode

fn from(t: &'a 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 Ord for StatusCode

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<StatusCode> for StatusCode

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u16> for StatusCode

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<StatusCode> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<&'a [u8]> for StatusCode

type Error = InvalidStatusCode

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a str> for StatusCode

type Error = InvalidStatusCode

The type returned in the event of a conversion error.

fn try_from(
    t: &'a str
) -> Result<StatusCode, <StatusCode as TryFrom<&'a 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.

impl Copy for StatusCode

impl Eq for StatusCode

impl StructuralEq for StatusCode

impl StructuralPartialEq for StatusCode