package travesty

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Travesty signatures

Monadically traversable containers

Install

dune-project

Dependency

mattwindsor91.github.io Readme Changelog Edit opam file Versions (8)

Authors

M

Matt Windsor <m.windsor@imperial.ac.uk>

Maintainers

M

Matt Windsor <m.windsor@imperial.ac.uk>

Sources

travesty-v0.6.0.tbz

sha256=64b136dadb5d7628dbdf5db18d4cae813a69f670979b028e5ce36db41c714064

sha512=086dbe8603047b549a0b97d9e8c3252ba71db0bd30bcb03eed24a86ad39ea52ee8118a29003bd20aea06d52b39e930e263d9a53215bfa58ea4bab7f856928add

doc/travesty.base_exts/Travesty_base_exts/Result/index.html

Module `Travesty_base_exts.Result`

Result monad extensions.

This module contains bi-traversability for Base's Result monad.

type ('ok, 'err) t = ('ok, 'err) Base.Result.t

Defined to let this module be used directly in chaining operations etc.

Travesty signatures

Result is a bi-traversable type, with the left type being the result type, and the right type the error type. This is backwards from Haskell conventions, but matches the positions of the type parameters.

include Travesty.Bi_traversable_types.S2
  with type ('ok, 'err) t := ('ok, 'err) t

include Base.T2 with type ('ok, 'err) t := ('ok, 'err) t

include Travesty.Bi_traversable_types.Generic
  with type ('l, 'r) t := ('l, 'r) t
   and type 'l left := 'l
   and type 'r right := 'r

include Travesty.Generic_types.Bi_generic
  with type ('l, 'r) t := ('l, 'r) t
  with type 'l left := 'l
  with type 'r right := 'r

We can do non-monadic bi-mapping operations.

include Travesty.Bi_mappable_types.Generic
  with type ('l, 'r) t := ('l, 'r) t
   and type 'l left := 'l
   and type 'r right := 'r

include Travesty.Bi_mappable_types.Basic_generic
  with type ('l, 'r) t := ('l, 'r) t
  with type 'l left := 'l
  with type 'r right := 'r

include Travesty.Generic_types.Bi_generic
  with type ('l, 'r) t := ('l, 'r) t
  with type 'l left := 'l
  with type 'r right := 'r

val bi_map : 
  ('l1, 'r1) t ->
  left:('l1 -> 'l2) ->
  right:('r1 -> 'r2) ->
  ('l2, 'r2) t

bi_map c ~left ~right maps left over every 'l1 left, and right over every 'r1 right, in c.

val map_left : ('l1, 'r) t -> f:('l1 -> 'l2) -> ('l2, 'r) t

map_left c ~f maps f over the left type of c only.

val map_right : ('l, 'r1) t -> f:('r1 -> 'r2) -> ('l, 'r2) t

map_right c ~f maps f over the right type of c only.

module On_monad
  (M : Base.Monad.S) : 
  Travesty.Bi_traversable_types.Generic_on_monad
    with type ('l, 'r) t := ('l, 'r) t
     and type 'l left := 'l
     and type 'r right := 'r
     and module M := M

On_monad implements monadic bi-traversal operators for a given monad M.

module With_errors : 
  Travesty.Bi_traversable_types.Generic_on_monad
    with type ('l, 'r) t := ('l, 'r) t
     and type 'l left := 'l
     and type 'r right := 'r
     and module M := Base.Or_error

With_errors specialises On_monad to the error_monad.