With_errors (p.travesty.0.7.2.doc.travesty.containers.Travesty_containers.Singleton.With

include Travesty.Traversable_types.Generic_on_monad
  with type 'a t := 'a t
   and type 'a elt := 'a
  with module M := Base.Or_error

All applicative operators are available through lowering the monad to an applicative functor.

include Travesty.Traversable_types.Generic_on_applicative
  with module M := Travesty.Monad_exts.App(Base.Or_error)
  with type 'a t := 'a t
  with type 'a elt := 'a

include Travesty.Traversable_types.Basic_generic_on_applicative
  with module M := Travesty.Monad_exts.App(Base.Or_error)
  with type 'a t := 'a t
  with type 'a elt := 'a

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 Travesty.Generic_types.Generic
  with type 'a t := 'a t
  with type 'a elt := 'a

Source

val map_m : 
  'a t ->
  f:('a -> 'b Travesty.Monad_exts.App(Base.Or_error).t) ->
  'b t Travesty.Monad_exts.App(Base.Or_error).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

Source

val fold_map_m : 
  'a t ->
  f:('acc -> 'a -> ('acc * 'b) Base.Or_error.t) ->
  init:'acc ->
  ('acc * 'b t) Base.Or_error.t

fold_map_m c ~f ~init folds f applicatively over every t in c, threading through an accumulator with initial value init.

Source

val fold_m : 
  'a t ->
  init:'acc ->
  f:('acc -> 'a -> 'acc Base.Or_error.t) ->
  'acc Base.Or_error.t

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.

Source

val iter_m : 
  'a t ->
  f:('a -> Base.unit Base.Or_error.t) ->
  Base.unit Base.Or_error.t

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

Source

val mapi_m : 
  f:(Base.int -> 'a -> 'b Base.Or_error.t) ->
  'a t ->
  'b t Base.Or_error.t

mapi_m ~f x behaves as map_m, but also supplies f with the index of the element. This index should match the actual position of the element in the container x.

Sourceval sequence_m : 'a Base.Or_error.t t -> 'a t Base.Or_error.t

sequence_m x lifts a container of applicatives x to an applicative containing a container, by sequencing the applicative effects from left to right.