package opium

You can search for identifiers within the package.

in-package search v0.2.0

opium
- Opium
  - App
  - Auth
    
    Challenge
    
    Credential
  - Body
  - Context
    
    Key
  - Cookie
    
    Signer
  - Handler
  - Headers
  - Method
  - Middleware
  - Request
  - Response
  - Route
  - Router
  - Status
  - Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Collection of handlers commonly used to build Opium applications

val serve : 
  ?mime_type:string ->
  ?etag:string ->
  ?headers:Headers.t ->
  (unit ->
    (Body.t, [ Status.client_error | Status.server_error ]) Lwt_result.t) ->
  Rock.Handler.t

serve ?mime_type ?etag ?headers read returns a handler that will serve the result of read ().

It is typically used to serve static file by providing a read function, either reading from the local filesystem, or from a remote one such as Amazon S3.

The response will contain an ETag header and a the HTTP code 304 will be returned if the computed ETag matches the one specified in the request.