The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Kelp::Exception - Tiny HTTP exceptions

SYNOPSIS

    # will log the body to 'error' level logger
    Kelp::Exception->throw(400, body => 'The request was malformed and got aborted');

    # will only show an error page with the code
    Kelp::Exception->throw(410);

    # code is optional - 500 by default
    Kelp::Exception->throw;

DESCRIPTION

This module offers a fine-grained control of what the user sees when an exception occurs. Generally, this could also be done by setting the result code manually, but that requires passing the Kelp instance around and does not immediately end the handling code. Exceptions are a way to end route handler execution from deep within the call stack.

This implementation is very incomplete and can only handle 4XX and 5XX status codes, meaning that you can't do redirects and normal responses like this. It also tries to maintain some degree of compatibility with HTTP::Exception without its complexity.

ATTRIBUTES

code

HTTP status code. Only possible are 5XX and 4XX.

Readonly. Required.

body

Body of the exception - can be anything that can be serialized and if passed will cause the application to log it on error level.

Content type and status string for the response will be set accordingly. Will render HTML in template and plaintext if there is no template (as usual errors do).

METHODS

throw

    # both do exactly the same
    Kelp::Exception->throw(...);
    die Kelp::Exception->new(...);

Same as simply constructing and calling die on an object.