Struct nickel::NickelError

pub struct NickelError<'a, D: 'a = ()> {
    pub stream: Option<Response<'a, D, Streaming>>,
    pub message: Cow<'static, str>,
}

NickelError is the basic error type for HTTP errors as well as user defined errors. One can pattern match against the kind property to handle the different cases.

Fields

stream: Option<Response<'a, D, Streaming>>

message: Cow<'static, str>

Implementations

impl<'a, D> NickelError<'a, D>

pub fn new<T>(
    stream: Response<'a, D, Fresh>,
    message: T,
    status_code: StatusCode
) -> NickelError<'a, D>where
    T: Into<Cow<'static, str>>,

Creates a new NickelError instance.

You should probably use Response#error in favor of this.

Examples

use nickel::{Request, Response, MiddlewareResult, NickelError};
use nickel::status::StatusCode;

fn handler<'a, D>(_: &mut Request<D>, res: Response<'a, D>) -> MiddlewareResult<'a, D> {
    Err(NickelError::new(res, "Error Parsing JSON", StatusCode::BadRequest))
}

pub unsafe fn without_response<T>(message: T) -> NickelError<'a, D>where
    T: Into<Cow<'static, str>>,

Creates a new NickelError without a Response.

This should only be called in a state where the Response has failed in an unrecoverable state. If there is an available Response then it must be provided to new so that the underlying stream can be flushed, allowing future requests.

This is considered unsafe as deadlock can occur if the Response does not have the underlying stream flushed when processing is finished.

pub fn end(self) -> Option<Result<()>>

Trait Implementations

impl<'a, T, D> From<(Response<'a, D, Fresh>, (StatusCode, T))> for NickelError<'a, D>where
    T: Into<Box<dyn Error + 'static>>,

fn from(
    (res, (errorcode, err)): (Response<'a, D>, (StatusCode, T))
) -> NickelError<'a, D>

Converts to this type from the input type.

impl<'a, D> From<(Response<'a, D, Fresh>, StatusCode)> for NickelError<'a, D>

fn from((res, code): (Response<'a, D>, StatusCode)) -> NickelError<'a, D>

Converts to this type from the input type.

impl<'a, D> From<(Response<'a, D, Fresh>, String)> for NickelError<'a, D>

fn from((res, msg): (Response<'a, D>, String)) -> NickelError<'a, D>

Converts to this type from the input type.