Use to create a result monad on top of an arbitrary monad.
How to create a promise-based result monad:
module MyError = struct
type t = A | B | C
end
module MyMonad = struct
type 'a t = 'a Lwt.t
let return = Lwt.return
let (>>=) = Lwt.(>>=)
end
module MyResult = Sugar.Promise.Make (MyError) (MyMonad)Notice that for most cases, you can just plug the module directly from a monadic library, like:
module MyResult = Sugar.Promise.Make (MyError) (Lwt)
module MyResult2 = Sugar.Promise.Make (MyError) (Async.Std.Deferred)module Make
(UserError : S.Params.Error)
(UserMonad : S.Params.Monad) :
S.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.