Struct Error

pub struct Error {
    pub code: u16,
    pub reason: &'static str,
    /* private fields */
}

A specialized Status struct that responds json errors.

This struct implements a Responder that will return json.

Examples

use rocket_contrib::json::JsonValue;
use rocket_json::{Error, Result};

fn example(error: bool) -> Result<JsonValue> {
    if error {
        // Rocket will return status code 503:
        // { "reason": "Service Unavailable", "status": 503 }
        return Err(Error::ServiceUnavailable);
    }
    // Rocket will return status code 200:
    // { "example": 42 }
    Ok(json!({ "example": 42 }))
}

Fields

code: u16

reason: &'static str

Implementations

impl Error

pub const MultipleChoices: Error = _

Error with code 300 and reason Multiple Choices .

pub const MovedPermanently: Error = _

Error with code 301 and reason Moved Permanently .

pub const Found: Error = _

Error with code 302 and reason Found .

pub const SeeOther: Error = _

Error with code 303 and reason See Other .

pub const NotModified: Error = _

Error with code 304 and reason Not Modified .

pub const UseProxy: Error = _

Error with code 305 and reason Use Proxy .

pub const TemporaryRedirect: Error = _

Error with code 307 and reason Temporary Redirect .

pub const PermanentRedirect: Error = _

Error with code 308 and reason Permanent Redirect .

pub const BadRequest: Error = _

Error with code 400 and reason Bad Request .

pub const Unauthorized: Error = _

Error with code 401 and reason Unauthorized .

pub const PaymentRequired: Error = _

Error with code 402 and reason Payment Required .

pub const Forbidden: Error = _

Error with code 403 and reason Forbidden .

pub const NotFound: Error = _

Error with code 404 and reason Not Found .

pub const MethodNotAllowed: Error = _

Error with code 405 and reason Method Not Allowed .

pub const NotAcceptable: Error = _

Error with code 406 and reason Not Acceptable .

pub const ProxyAuthenticationRequired: Error = _

Error with code 407 and reason Proxy Authentication Required .

pub const RequestTimeout: Error = _

Error with code 408 and reason Request Timeout .

pub const Conflict: Error = _

Error with code 409 and reason Conflict .

pub const Gone: Error = _

Error with code 410 and reason Gone .

pub const LengthRequired: Error = _

Error with code 411 and reason Length Required .

pub const PreconditionFailed: Error = _

Error with code 412 and reason Precondition Failed .

pub const PayloadTooLarge: Error = _

Error with code 413 and reason Payload Too Large .

pub const UriTooLong: Error = _

Error with code 414 and reason URI Too Long .

pub const UnsupportedMediaType: Error = _

Error with code 415 and reason Unsupported Media Type .

pub const RangeNotSatisfiable: Error = _

Error with code 416 and reason Range Not Satisfiable .

pub const ExpectationFailed: Error = _

Error with code 417 and reason Expectation Failed .

pub const ImATeapot: Error = _

Error with code 418 and reason I’m a teapot .

pub const MisdirectedRequest: Error = _

Error with code 421 and reason Misdirected Request .

pub const UnprocessableEntity: Error = _

Error with code 422 and reason Unprocessable Entity .

pub const Locked: Error = _

Error with code 423 and reason Locked .

pub const FailedDependency: Error = _

Error with code 424 and reason Failed Dependency .

pub const UpgradeRequired: Error = _

Error with code 426 and reason Upgrade Required .

pub const PreconditionRequired: Error = _

Error with code 428 and reason Precondition Required .

pub const TooManyRequests: Error = _

Error with code 429 and reason Too Many Requests .

pub const RequestHeaderFieldsTooLarge: Error = _

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

pub const UnavailableForLegalReasons: Error = _

Error with code 451 and reason Unavailable For Legal Reasons .

pub const InternalServerError: Error = _

Error with code 500 and reason Internal Server Error .

pub const NotImplemented: Error = _

Error with code 501 and reason Not Implemented .

pub const BadGateway: Error = _

Error with code 502 and reason Bad Gateway .

pub const ServiceUnavailable: Error = _

Error with code 503 and reason Service Unavailable .

pub const GatewayTimeout: Error = _

Error with code 504 and reason Gateway Timeout .

pub const HttpVersionNotSupported: Error = _

Error with code 505 and reason HTTP Version Not Supported .

pub const VariantAlsoNegotiates: Error = _

Error with code 506 and reason Variant Also Negotiates .

pub const InsufficientStorage: Error = _

Error with code 507 and reason Insufficient Storage .

pub const LoopDetected: Error = _

Error with code 508 and reason Loop Detected .

pub const NotExtended: Error = _

Error with code 510 and reason Not Extended .

pub const NetworkAuthenticationRequired: Error = _

Error with code 511 and reason Network Authentication Required .

pub fn new(code: u16, reason: &'static str) -> Self

pub fn extend(self, data: JsonValue) -> Self

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl From<Status> for Error

fn from(status: Status) -> Self

Converts to this type from the input type.

impl Into<Status> for Error

fn into(self) -> Status

Converts this type into the (usually inferred) input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'r> Responder<'r> for Error

fn respond_to(self, req: &Request<'_>) -> Result<Response<'r>, Status>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.

impl StructuralPartialEq for Error