package rock

You can search for identifiers within the package.

in-package search v0.2.0

rock
- Rock
  - App
  - Body
  - Context
    
    Key
  - Filter
  - Handler
  - Middleware
  - Request
  - Response
  - Server_connection
  - Service

Legend:
Library
Module
Module type
Parameter
Class
Class type

Collection of functions to run a server from a Rock app.

type error_handler =
  Httpaf.Headers.t ->
  Httpaf.Server_connection.error ->
  (Httpaf.Headers.t * Body.t) Lwt.t

val run : 
  (request_handler:Httpaf.Server_connection.request_handler ->
    error_handler:Httpaf.Server_connection.error_handler ->
    'a Lwt.t) ->
  ?error_handler:error_handler ->
  App.t ->
  'a Lwt.t

exception Halt of Response.t

The Halt exception can be raised to interrupt the normal processing flow of a request.

The exception will be handled by the main run function (in Server_connection.run) and the response will be sent to the client directly.

This is especially useful when you want to make sure that no other middleware will be able to modify the response.

val halt : Response.t -> 'a

Raises a Halt exception to interrupt the processing of the connection and trigger an early response.