package travesty
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=49d43ea0e9cef32d493fcc1561fc7480c55d9a2490700e487f4d5c3aff562d61
sha512=1cd77071adfb4583d0fcd27469b97bc64b7278761949aaaf415768aec14f6a1243e14575155c75033a5141a0320b4f56687381dc2bc56432a5ea63ea8613d968
doc/travesty.containers/Travesty_containers/Zipper/Make_marked/On_option/index.html
Module Make_marked.On_optionSource
On_option is On_monad specialised to the option monad.
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 Base.Option.t) ->
'a Base.Option.tpeek_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 Base.Option.t) ->
'a t Base.Option.tstep_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 Base.Option.t) ->
on_empty:('a t -> 'a t Base.Option.t) ->
'a t Base.Option.tmap_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:Mark.t ->
on_empty:('a t -> 'a t Base.Option.t) ->
'a t Base.Option.tmark_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:Mark.t ->
on_empty:('a t -> 'a t Base.Option.t) ->
'a t Base.Option.trecall_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:Mark.t ->
on_empty:('a t -> 'a t Base.Option.t) ->
'a t Base.Option.tdelete_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 Base.Option.t) ->
init:'acc ->
finish:('acc -> 'a t -> 'final Base.Option.t) ->
'final Base.Option.tfold_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.