package travesty
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=49d43ea0e9cef32d493fcc1561fc7480c55d9a2490700e487f4d5c3aff562d61
sha512=1cd77071adfb4583d0fcd27469b97bc64b7278761949aaaf415768aec14f6a1243e14575155c75033a5141a0320b4f56687381dc2bc56432a5ea63ea8613d968
doc/travesty.containers/Travesty_containers/Zipper/Make_marked/On_monad/index.html
Module Make_marked.On_monad
Source
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
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.
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.
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.
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.
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.
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 ->
(Mark.t, '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.