package biocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Future.S with type 'a Deferred.t = 'a and type 'a Pipe.Reader.t = 'a Stream.t and type Reader.t = Core.In_channel.t and type Writer.t = Core.Out_channel.t
type how = [
  1. | `Parallel
  2. | `Sequential
  3. | `Max_concurrent_jobs of int
]

`Max_concurrent_jobs supported only for Async implementation. The Lwt implementation treats this the same as `Parallel. Blocking implementation treats all as `Sequential.

module Deferred : sig ... end
val return : 'a -> 'a Deferred.t
val (>>=) : 'a Deferred.t -> ('a -> 'b Deferred.t) -> 'b Deferred.t
val (>>|) : 'a Deferred.t -> ('a -> 'b) -> 'b Deferred.t
val (>>=?) : ('a, 'b) Deferred.Result.t -> ('a -> ('c, 'b) Deferred.Result.t) -> ('c, 'b) Deferred.Result.t
val (>>|?) : ('a, 'b) Deferred.Result.t -> ('a -> 'c) -> ('c, 'b) Deferred.Result.t
val fail : exn -> 'a Deferred.t

Difference from Async: Use fail instead of raise.

val raise : [> `Use_fail_instead ]
val try_with : (unit -> 'a Deferred.t) -> ('a, exn) Core.Result.t Deferred.t

Async supports several extra parameters to this function, which we do not currently support.

module In_thread : sig ... end
module Pipe : sig ... end
module Reader : sig ... end
module Writer : sig ... end
OCaml

Innovation. Community. Security.