Enum http_api_problem::HttpStatusCode

[+] Show declaration

pub enum HttpStatusCode {
    Continue,
    SwitchingProtocols,
    Processing,
    Ok,
    Created,
    Accepted,
    NonAuthoritativeInformation,
    NoContent,
    ResetContent,
    PartialContent,
    MultiStatus,
    AlreadyReported,
    ImUsed,
    MultipleChoices,
    MovedPermanently,
    Found,
    SeeOther,
    NotModified,
    UseProxy,
    TemporaryRedirect,
    PermanentRedirect,
    BadRequest,
    Unauthorized,
    PaymentRequired,
    Forbidden,
    NotFound,
    MethodNotAllowed,
    NotAcceptable,
    ProxyAuthenticationRequired,
    RequestTimeout,
    Conflict,
    Gone,
    LengthRequired,
    PreconditionFailed,
    PayloadTooLarge,
    UriTooLong,
    UnsupportedMediaType,
    RangeNotSatisfiable,
    ExpectationFailed,
    ImATeapot,
    MisdirectedRequest,
    UnprocessableEntity,
    Locked,
    FailedDependency,
    UpgradeRequired,
    PreconditionRequired,
    TooManyRequests,
    RequestHeaderFieldsTooLarge,
    UnavailableForLegalReasons,
    InternalServerError,
    NotImplemented,
    BadGateway,
    ServiceUnavailable,
    GatewayTimeout,
    HttpVersionNotSupported,
    VariantAlsoNegotiates,
    InsufficientStorage,
    LoopDetected,
    NotExtended,
    NetworkAuthenticationRequired,
    Unregistered(u16),
}

[−] Expand description

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

This enum contains all common status codes and an Unregistered extension variant. It allows status codes in the range [0, 65535], as any u16 integer may be used as a status code for XHR requests. It is recommended to only use values between [100, 599], since only these are defined as valid status codes with a status class by HTTP.

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

Shamelessly copied from iron.

Variants

ContinueSwitchingProtocolsProcessingOkCreatedAcceptedNonAuthoritativeInformationNoContentResetContentPartialContentMultiStatusAlreadyReportedImUsedMultipleChoicesMovedPermanentlyFoundSeeOtherNotModifiedUseProxyTemporaryRedirectPermanentRedirectBadRequestUnauthorizedPaymentRequiredForbiddenNotFoundMethodNotAllowedNotAcceptableProxyAuthenticationRequiredRequestTimeoutConflictGoneLengthRequiredPreconditionFailedPayloadTooLargeUriTooLongUnsupportedMediaTypeRangeNotSatisfiableExpectationFailedImATeapotMisdirectedRequestUnprocessableEntityLockedFailedDependencyUpgradeRequiredPreconditionRequiredTooManyRequestsRequestHeaderFieldsTooLargeUnavailableForLegalReasonsInternalServerErrorNotImplementedBadGatewayServiceUnavailableGatewayTimeoutHttpVersionNotSupportedVariantAlsoNegotiatesInsufficientStorageLoopDetectedNotExtendedNetworkAuthenticationRequiredUnregistered(u16)

Methods

impl HttpStatusCode

[−]

pub fn is_informational(&self) -> bool

[−]

HttpStatusCode is within 100-199.

pub fn is_success(&self) -> bool

[−]

HttpStatusCode is within 200-299.

pub fn is_redirection(&self) -> bool

[−]

HttpStatusCode is within 300-399.

pub fn is_client_error(&self) -> bool

[−]

HttpStatusCode is within 400-499.

pub fn is_server_error(&self) -> bool

[−]

HttpStatusCode is within 500-599.

pub fn title(&self) -> &'static str

[−]

A descriptive title for the status code which does not contain the numeric code itself.

#Example

use http_api_problem::*;

assert_eq!("Internal Server Error", HttpStatusCode::InternalServerError.title());

pub fn to_u16(&self) -> u16

[−]

The numeric status code

#Example

use http_api_problem::*;

assert_eq!(500, HttpStatusCode::InternalServerError.to_u16());

Trait Implementations

impl From<HttpStatusCode> for HttpApiProblem

[+]

fn from(status: HttpStatusCode) -> HttpApiProblem

[−]

Performs the conversion.

impl Debug for HttpStatusCode

[+]

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

[−]

Formats the value using the given formatter.

impl Clone for HttpStatusCode

[+]

fn clone(&self) -> HttpStatusCode

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Copy for HttpStatusCode

impl PartialEq for HttpStatusCode

[+]

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

[−]

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

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

[−]

This method tests for !=.

impl Eq for HttpStatusCode

impl From<u16> for HttpStatusCode

[+]

fn from(n: u16) -> HttpStatusCode

[−]

Performs the conversion.

impl Display for HttpStatusCode

[+]

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

[−]

Formats the value using the given formatter.

impl Serialize for HttpStatusCode

[+]

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where     S: Serializer,

[−]

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for HttpStatusCode

[+]

fn deserialize<D>(deserializer: D) -> Result<HttpStatusCode, D::Error> where     D: Deserializer<'de>,

[−]

Deserialize this value from the given Serde deserializer.