package travesty

You can search for identifiers within the package.

in-package search v0.2.0

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.1.tbz

sha256=9c7b3803620c54496a35983285242ec8e06a5efb1baa3523384d7184b7e9fab7

sha512=991646fe5bb899971d3f8c00432d4df6c45dbd81cbff885b28d30d9c228e5df61f1e8d61aadc164ec35c448093abb34fd7a7d571e1cdf4d3af25579bf400f167

doc/travesty.containers/Travesty_containers/Zipper/Int_mark_zipper/On_monad/index.html

Module `Int_mark_zipper.On_monad`

On_monad provides various marked zipper operations parametrised by a monad.

Parameters

module M : Base.Monad.S

Signature

include Zipper_types.S_monadic with type 'a t := 'a t with module M := M

val pop_m : 'a t -> on_empty:('a t -> ('a * 'a t) M.t) -> ('a * 'a t) M.t

pop_m zipper ~on_empty behaves like pop, but executes a custom monadic action on_empty, instead of returning an error, when the cursor is empty.

val peek_m : ?steps:Base.int -> 'a t -> on_empty:('a t -> 'a M.t) -> 'a M.t

peek_m ?steps zipper ~on_empty behaves like peek_opt, but executes a custom monadic action on_empty, instead of returning None, when the cursor is empty.

val step_m : ?steps:Base.int -> 'a t -> on_empty:('a t -> 'a t M.t) -> 'a t M.t

step_m ?steps zipper ~on_empty behaves like step, but executes a custom monadic action on_empty, instead of returning an error, when the cursor is empty.

val map_m_head : 
  'a t ->
  f:('a -> 'a Base.option M.t) ->
  on_empty:('a t -> 'a t M.t) ->
  'a t M.t

map_m_head ?steps zipper ~on_empty behaves like map_head, but executes a custom monadic action on_empty, instead of leaving the zipper unchanged, when the cursor is empty.

val mark_m : 'a t -> mark:Base.int -> on_empty:('a t -> 'a t M.t) -> 'a t M.t

mark_m zipper ~mark ~on_empty behaves like mark, but executes a custom monadic action on_empty, instead of returning an error, when the cursor is empty.

val recall_m : 'a t -> mark:Base.int -> on_empty:('a t -> 'a t M.t) -> 'a t M.t

recall_m zipper ~mark ~on_empty behaves like recall, but executes a custom monadic action on_empty, instead of returning an error, when the mark can't be found.

val delete_to_mark_m : 
  'a t ->
  mark:Base.int ->
  on_empty:('a t -> 'a t M.t) ->
  'a t M.t

delete_to_mark_m zipper ~mark ~on_empty behaves like delete_to_mark, but executes a custom monadic action on_empty, instead of returning an error, when the mark can't be found.

val fold_m_until : 
  'a t ->
  f:
    ('acc ->
      'a ->
      'a t ->
      (Base.int, 'a, 'acc, 'final) Zipper_types.fold_outcome M.t) ->
  init:'acc ->
  finish:('acc -> 'a t -> 'final M.t) ->
  'final M.t

fold_m_until zipper ~f ~init ~finish behaves like fold_until, except that f and finish, and therefore the function itself, return results inside a monad context.

On This Page

Parameters
Signature