This module is similar to Sugar.Promise. It lets you create a result monad on top of an arbitrary monad.
The main difference is that the functions in this module were created to recognize unexpected exceptions, and require you to provide some mecanism to recover from that. This is done with the signatures for strict error and strict monad.
An example:
module MyError = struct
type t = A | B | Unexpected of exn
let panic e = Unexpected e
end
module MyMonad = struct
type 'a t = 'a Lwt.t
let return = Lwt.return
let (>>=) = Lwt.(>>=)
let catch = Lwt.catch
end
module MyResult = Sugar.Strict.Promise.Make (MyError) (MyMonad)Notice that the signature for the required strict monad is the same as the Lwt library. That means, you can just plug it in:
module MyResult = Sugar.Strict.Promise.Make (MyError) (Lwt)module Make
(UserError : S.Params.Strict_error)
(UserMonad : S.Params.Strict_monad) :
S.Strict_promise
with type error := UserError.t
and type 'a monad := 'a UserMonad.t
and type 'a value = ('a, UserError.t) Result.result
and type 'a result = ('a, UserError.t) Result.result UserMonad.tA parametric module that implements the monadic interface for values. The complete documentation can be found in Sugar.S.Promise.