Generic.On_monad
On_monad
implements traversal operators for a given monad M
. Compared to On(Monad_exts.App(M))
, this adds various derived operators available only for monads.
All applicative operators are available through lowering the monad to an applicative functor.
include Generic_on_applicative
with module M := Monad_exts.App(M)
with type ('a, 'phantom) t := ('a, 'phantom) t
with type 'a elt := 'a elt
include Basic_generic_on_applicative
with module M := Monad_exts.App(M)
with type ('a, 'phantom) t := ('a, 'phantom) t
with type 'a elt := 'a elt
Generic
refers to the container type as 'a t
, and the element type as 'a elt
; substitute t
/elt
(arity-0) or 'a t
/'a
(arity-1) accordingly below.
include Generic_types.Generic
with type ('a, 'phantom) t := ('a, 'phantom) t
with type 'a elt := 'a elt
val map_m :
('a, 'phantom) t ->
f:('a elt -> 'b elt Travesty.Monad_exts.App(M).t) ->
('b, 'phantom) t Travesty.Monad_exts.App(M).t
map_m c ~f
maps f
over every t
in c
, threading through an applicative functor.
Example:
(* Travesty_base_exts.List adds applicative traversals to a list;
With_errors (in S1_container) implements them on the On_error
applicative functor. *)
let f x =
Or_error.(if 0 < x then error_string "negative!" else ok x)
in
List.With_errors.map_m integers ~f
val fold_map_m :
('a, 'phantom) t ->
f:('acc -> 'a elt -> ('acc * 'b elt) M.t) ->
init:'acc ->
('acc * ('b, 'phantom) t) M.t
fold_map_m c ~f ~init
folds f
applicatively over every t
in c
, threading through an accumulator with initial value init
.
fold_m x ~init ~f
folds the applicative computation f
over x
, starting with initial value init
, and returning the final value inside the applicative effect.
iter_m x ~f
iterates the computation f
over x
, returning the final applicative effect.