Enum sharp_pencil::http_errors::HTTPError

pub enum HTTPError {
    BadRequest,
    Unauthorized,
    Forbidden,
    NotFound,
    MethodNotAllowed(Option<Vec<Method>>),
    NotAcceptable,
    RequestTimeout,
    Conflict,
    Gone,
    LengthRequired,
    PreconditionFailed,
    RequestEntityTooLarge,
    RequestURITooLarge,
    UnsupportedMediaType,
    RequestedRangeNotSatisfiable,
    ExpectationFailed,
    ImATeapot,
    UnprocessableEntity,
    PreconditionRequired,
    TooManyRequests,
    RequestHeaderFieldsTooLarge,
    InternalServerError,
    NotImplemented,
    BadGateway,
    ServiceUnavailable,
}

The HTTP Error type you can return from within your views to trigger a non-200 response. Here is one usage example:

use sharp_pencil::{Request, PencilResult, PenHTTPError};
use sharp_pencil::http_errors::NotFound;


fn view(_: &mut Request) -> PencilResult {
    return Err(PenHTTPError(NotFound))
}

Pencil comes with a shortcut that can be used to return non-200 HTTP error easily:

use sharp_pencil::{Request, PencilResult};
use sharp_pencil::abort;


fn view(_: &mut Request) -> PencilResult {
    return abort(404)
}

Variants

BadRequest

Unauthorized

Forbidden

NotFound

MethodNotAllowed(Option<Vec<Method>>)

NotAcceptable

RequestTimeout

Conflict

Gone

LengthRequired

PreconditionFailed

RequestEntityTooLarge

RequestURITooLarge

UnsupportedMediaType

RequestedRangeNotSatisfiable

ExpectationFailed

ImATeapot

UnprocessableEntity

PreconditionRequired

TooManyRequests

RequestHeaderFieldsTooLarge

InternalServerError

NotImplemented

BadGateway

ServiceUnavailable

Implementations

impl HTTPError

pub fn new(code: u16) -> HTTPError

Create a new HTTPError.

pub fn code(&self) -> u16

The status code.

pub fn name(&self) -> &str

The status name.

pub fn get_body(&self) -> String

Get the HTML body.

pub fn to_response(&self) -> Response

Get a response object.

Trait Implementations

impl Clone for HTTPError

fn clone(&self) -> HTTPError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HTTPError

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

Formats the value using the given formatter.

impl Display for HTTPError

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

Formats the value using the given formatter.

impl Error for HTTPError

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<HTTPError> for PencilError

fn from(err: HTTPError) -> PencilError

Performs the conversion.