package sugar

You can search for identifiers within the package.

in-package search v0.2.0

sugar
- Sugar
  - Option
    
    Infix
    
    Monad
  - Promise
    
    Make
    
    Infix
    
    UserError
    
    UserMonad
  - Result
    
    Make
    
    For
    
    Infix
    
    UserMonad
    
    Infix
    
    UserError
  - S
    
    Params
    
    Error
    
    Monad
    
    Strict_error
    
    Strict_monad
    
    Promise
    
    Infix
    
    Result
    
    For
    
    Infix
    
    UserMonad
    
    Infix
    
    Result_partials
    
    Infix
    
    Strict_promise
    
    Infix
    
    NoExceptions
    
    Infix
    
    Strict_result
    
    For
    
    Infix
    
    NoExceptions
    
    Infix
    
    UserMonad
    
    Infix
    
    NoExceptions
    
    For
    
    Infix
    
    UserMonad
    
    Infix
  - Strict
    
    Promise
    
    Make
    
    Infix
    
    NoExceptions
    
    Infix
    
    UserError
    
    UserMonad
    
    Result
    
    Make
    
    For
    
    Infix
    
    NoExceptions
    
    Infix
    
    UserMonad
    
    Infix
    
    NoExceptions
    
    For
    
    Infix
    
    UserMonad
    
    Infix
    
    UserError

Legend:
Library
Module
Module type
Parameter
Class
Class type

include S.Params.Monad

type 'a t

A parametric type representing any OCaml value.

val return : 'a -> 'a t

Creates a constant value in this monad.

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

Waits for the conclusion of the monad in the left, and then, apply the unwrapped value to the function in the right.

val catch : (unit -> 'a t) -> (exn -> 'a t) -> 'a t

Checks if the monad returned by the thunk raised an exception, and applies the given error handler if necessary.

This function has intentionally the exact signature as Lwt.catch. This means the Lwt module is already a Strict_monad:

let _ =
  (module Lwt: Sugar.Params.Strict_monad)