package monads

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Make(M) derives Monad.S from the Basic implementation

Parameters

module M : Basic

Signature

val void : 'a M.t -> unit M.t

void m computes m and discrards the result.

val sequence : unit M.t list -> unit M.t

sequence xs computes a sequence of computations xs in the left to right order.

val forever : 'a M.t -> 'b M.t

forever xs creates a computationt that never returns.

module Fn : sig ... end

Various function combinators lifted into the Kleisli category.

module Pair : sig ... end

The pair interface lifted into the monad.

module Triple : sig ... end

The triple interface lifted into a monad.

module Lift : sig ... end

Lifts functions into the monad.

module Exn : sig ... end

Interacting between monads and language exceptions

module Collection : sig ... end

Lifts collection interface into the monad.

module List : Collection.S with type 'a t := 'a list

The Monad.Collection.S interface for lists

module Seq : Collection.S with type 'a t := 'a Core_kernel.Sequence.t

The Monad.Collection.S interface for sequences

include Syntax.S with type 'a t := 'a M.t
val (>=>) : ('a -> 'b M.t) -> ('b -> 'c M.t) -> 'a -> 'c M.t

f >=> g is fun x -> f x >>= g

val (!!) : 'a -> 'a M.t

!!x is return x

val (!$) : ('a -> 'b) -> 'a M.t -> 'b M.t

!$f is Lift.unary f

val (!$$) : ('a -> 'b -> 'c) -> 'a M.t -> 'b M.t -> 'c M.t

!$$f is Lift.binary f

val (!$$$) : ('a -> 'b -> 'c -> 'd) -> 'a M.t -> 'b M.t -> 'c M.t -> 'd M.t

!$$$f is Lift.ternary f

val (!$$$$) : ('a -> 'b -> 'c -> 'd -> 'e) -> 'a M.t -> 'b M.t -> 'c M.t -> 'd M.t -> 'e M.t

!$$$$f is Lift.quaternary f

val (!$$$$$) : ('a -> 'b -> 'c -> 'd -> 'e -> 'f) -> 'a M.t -> 'b M.t -> 'c M.t -> 'd M.t -> 'e M.t -> 'f M.t

!$$$$$f is Lift.quinary f

include Core_kernel.Monad.S with type 'a t := 'a M.t
val (>>=) : 'a M.t -> ('a -> 'b M.t) -> 'b M.t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

val (>>|) : 'a M.t -> ('a -> 'b) -> 'b M.t

t >>| f is t >>= (fun a -> return (f a)).

module Monad_infix : sig ... end
val bind : 'a M.t -> f:('a -> 'b M.t) -> 'b M.t

bind t ~f = t >>= f

val return : 'a -> 'a M.t

return v returns the (trivial) computation that returns v.

val map : 'a M.t -> f:('a -> 'b) -> 'b M.t

map t ~f is t >>| f.

val join : 'a M.t M.t -> 'a M.t

join t is t >>= (fun t' -> t').

val ignore_m : 'a M.t -> unit M.t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Caml.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a M.t list -> 'a list M.t
val all_unit : unit M.t list -> unit M.t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

val all_ignore : unit M.t list -> unit M.t
  • deprecated [since 2018-02] Use [all_unit]
module Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

module Syntax : Syntax.S with type 'a t := 'a M.t

Monadic operators, see Monad.Syntax.S for more.

OCaml

Innovation. Community. Security.