Struct hypers_openapi::StatusError

#[non_exhaustive]
pub struct StatusError {
    pub code: StatusCode,
    pub name: String,
    pub detail: String,
}

StatusError contains http error information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: StatusCode

Http error status code.

name: String

Http error name.

detail: String

Detail information about http error.

Implementations

impl StatusError

pub fn detail(self, detail: impl Into<String>) -> Self

Sets detail field and returns Self.

pub fn bad_request() -> StatusError

The request could not be understood by the server due to malformed syntax.

400 Bad Request [RFC7231, Section 6.5.1]

pub fn unauthorized() -> StatusError

The request requires user authentication.

401 Unauthorized [RFC7235, Section 3.1]

pub fn payment_required() -> StatusError

The request could not be processed due to lack of payment.

402 Payment Required [RFC7231, Section 6.5.2]

pub fn forbidden() -> StatusError

The server refused to authorize the request.

403 Forbidden [RFC7231, Section 6.5.3]

pub fn not_found() -> StatusError

The requested resource could not be found.

404 Not Found [RFC7231, Section 6.5.4]

pub fn method_not_allowed() -> StatusError

The request method is not supported for the requested resource.

405 Method Not Allowed [RFC7231, Section 6.5.5]

pub fn not_acceptable() -> StatusError

The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

406 Not Acceptable [RFC7231, Section 6.5.6]

pub fn proxy_authentication_required() -> StatusError

Authentication with the proxy is required.

407 Proxy Authentication Required [RFC7235, Section 3.2]

pub fn request_timeout() -> StatusError

The server timed out waiting for the request.

408 Request Timeout [RFC7231, Section 6.5.7]

pub fn conflict() -> StatusError

The request could not be processed because of a conflict in the request.

409 Conflict [RFC7231, Section 6.5.8]

pub fn gone() -> StatusError

The resource requested is no longer available and will not be available again.

410 Gone [RFC7231, Section 6.5.9]

pub fn length_required() -> StatusError

The request did not specify the length of its content, which is required by the requested resource.

411 Length Required [RFC7231, Section 6.5.10]

pub fn precondition_failed() -> StatusError

The server does not meet one of the preconditions specified in the request.

412 Precondition Failed [RFC7232, Section 4.2]

pub fn payload_too_large() -> StatusError

The request is larger than the server is willing or able to process.

413 Payload Too Large [RFC7231, Section 6.5.11]

pub fn uri_too_long() -> StatusError

The URI provided was too long for the server to process.

414 URI Too Long [RFC7231, Section 6.5.12]

pub fn unsupported_media_type() -> StatusError

The request entity has a media type which the server or resource does not support.

415 Unsupported Media Type [RFC7231, Section 6.5.13]

pub fn range_not_satisfiable() -> StatusError

The portion of the requested file cannot be supplied by the server.

416 Range Not Satisfiable [RFC7233, Section 4.4]

pub fn expectation_failed() -> StatusError

The server cannot meet the requirements of the expect request-header field.

417 Expectation Failed [RFC7231, Section 6.5.14]

pub fn im_a_teapot() -> StatusError

I was requested to brew coffee, and I am a teapot.

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

pub fn misdirected_request() -> StatusError

The server cannot produce a response for this request.

421 Misdirected Request RFC7540, Section 9.1.2

pub fn unprocessable_entity() -> StatusError

The request was well-formed but was unable to be followed due to semantic errors.

422 Unprocessable Entity [RFC4918]

pub fn locked() -> StatusError

The source or destination resource of a method is locked.

423 Locked [RFC4918]

pub fn failed_dependency() -> StatusError

The method could not be performed on the resource because the requested action depended on another action and that action failed.

424 Failed Dependency [RFC4918]

pub fn upgrade_required() -> StatusError

Switching to the protocol in the Upgrade header field is required.

426 Upgrade Required [RFC7231, Section 6.5.15]

pub fn precondition_required() -> StatusError

The server requires the request to be conditional.

428 Precondition Required [RFC6585]

pub fn too_many_requests() -> StatusError

Too many requests have been received recently.

429 Too Many Requests [RFC6585]

pub fn request_header_fields_toolarge() -> StatusError

The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.

431 Request Header Fields Too Large [RFC6585]

pub fn unavailable_for_legalreasons() -> StatusError

The requested resource is unavailable due to a legal demand to deny access to this resource.

451 Unavailable For Legal Reasons [RFC7725]

pub fn internal_server_error() -> StatusError

The server encountered an internal error while processing this request.

500 Internal Server Error [RFC7231, Section 6.6.1]

pub fn not_implemented() -> StatusError

The server either does not recognize the request method, or it lacks the ability to fulfill the request.

501 Not Implemented [RFC7231, Section 6.6.2]

pub fn bad_gateway() -> StatusError

Received an invalid response from an inbound server it accessed while attempting to fulfill the request.

502 Bad Gateway [RFC7231, Section 6.6.3]

pub fn service_unavailable() -> StatusError

The server is currently unavailable.

503 Service Unavailable [RFC7231, Section 6.6.4]

pub fn gateway_timeout() -> StatusError

The server did not receive a timely response from an upstream server.

504 Gateway Timeout [RFC7231, Section 6.6.5]

pub fn http_version_not_supported() -> StatusError

The server does not support, or refuses to support, the major version of HTTP that was used in the request message.

505 HTTP Version Not Supported [RFC7231, Section 6.6.6]

pub fn variant_also_negotiates() -> StatusError

The server has an internal configuration error.

506 Variant Also Negotiates [RFC2295]

pub fn insufficient_storage() -> StatusError

The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.

507 Insufficient Storage [RFC4918]

pub fn loop_detected() -> StatusError

the server terminated an operation because it encountered an infinite loop while processing a request with “Depth: infinity”.

508 Loop Detected [RFC5842]

pub fn not_extended() -> StatusError

Further extensions to the request are required for the server to fulfill it.

510 Not Extended [RFC2774]

pub fn network_authentication_required() -> StatusError

the client needs to authenticate to gain network access.

511 Network Authentication Required [RFC6585]

Trait Implementations

impl Debug for StatusError

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

Formats the value using the given formatter.

impl Display for StatusError

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

Formats the value using the given formatter.

impl HandlerOut for StatusError

fn register(components: &mut Components, operation: &mut Operation)

Modify the OpenApi components section or current operation information with given argument. This function is called by macros internal.

impl ToResponses for StatusError

fn to_responses(components: &mut Components) -> Responses

Returns an ordered map of response codes to responses.

impl ToSchema for StatusError

fn to_schema(components: &mut Components) -> RefOr<Schema>

Returns a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.