package webmachine

  1. Overview
  2. Docs
A REST toolkit for OCaml

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (7)

Authors

  1. S
    Spiros Eliopoulos <spiros@inhabitedtype.com>

Maintainers

  1. S
    Spiros Eliopoulos <spiros@inhabitedtype.com>

Sources

0.6.2.tar.gz
sha256=d6e6567c1e177aefe6f1a62a32ff61942521866ee1579a55ffb2b7970ddc04c4
md5=e49e81e81ac0527e452aa6f6fd5c9616

doc/webmachine/Webmachine/index.html

Module WebmachineSource

A REST toolkit for OCaml.

Webmachine is a port of the Erlang project of the same name, designed to work as a REST-aware layer on top of cohttp.

To use this module, apply the Make functor to an IO and a CLOCK module, and subclass the resouce virtual class.

Sourcemodule type IO = sig ... end

The IO module signature abstracts over monadic futures library. It is a much reduced version of the module signature that appears in Cohttp, and as such is compatible with any module that conforms to Cohttp.S.IO.

Sourcemodule Rd : sig ... end

The Rd module is the means by which handlers access and manipulate request-specific information.

Sourcemodule type S = sig ... end
Sourcemodule type CLOCK = sig ... end

The CLOCK module signature defines a clock source, that is used with the Webmachine.Make(IO)(Clock) functor.

Sourcemodule Make (IO : IO) (Clock : CLOCK) : S with type +'a io = 'a IO.t