package travesty

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

On implements traversal operators for a given applicative M.

Parameters

module M : Base.Applicative.S

Signature

include Traversable_types.Basic_generic_on_applicative with type 'a t := Outer.Elt.t with type 'a elt := Elt.t with module M := M

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 t := Outer.Elt.t with type 'a elt := Elt.t
val map_m : Outer.Elt.t -> f:(Elt.t -> Elt.t M.t) -> Outer.Elt.t 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 iter_m : Outer.Elt.t -> f:(Elt.t -> Base.unit M.t) -> Base.unit M.t

iter_m x ~f iterates the computation f over x, returning the final applicative effect.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct