package travesty

  1. Overview
  2. Docs
Traversable containers, monad extensions, and more

Install 

dune-project
 Dependency

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

Authors

  1. M
    Matt Windsor <mattwindsor91@gmail.com>

Maintainers

  1. M
    Matt Windsor <mattwindsor91@gmail.com>

Sources

travesty-0.8.0.tbz
sha256=216c920c872cef2d52fa58e3c49826766a2cf6f2233e64937f18c46c0c5c5388
sha512=3b4f76794666aa3fb16c3639479790df3478a79e6f582b3e66b144e57df26a76580499961dd374f4fb6f3bd2dd7506e2725ed1242bada9deb14eb1916cacd18f

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

Module Int_mark_zipper.On_monadSource

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
Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.

Sourceval 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.