package travesty
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=64b136dadb5d7628dbdf5db18d4cae813a69f670979b028e5ce36db41c714064
sha512=086dbe8603047b549a0b97d9e8c3252ba71db0bd30bcb03eed24a86ad39ea52ee8118a29003bd20aea06d52b39e930e263d9a53215bfa58ea4bab7f856928add
doc/travesty.containers/Travesty_containers/Zipper/Int_mark_zipper/On_error/index.html
Module Int_mark_zipper.On_error
On_error is On_monad specialised to the error monad.
val pop_m :
'a t ->
on_empty:('a t -> ('a * 'a t) Base.Or_error.t) ->
('a * 'a t) Base.Or_error.tpop_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.Or_error.t) ->
'a Base.Or_error.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.Or_error.t) ->
'a t Base.Or_error.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.Or_error.t) ->
on_empty:('a t -> 'a t Base.Or_error.t) ->
'a t Base.Or_error.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:Base.int ->
on_empty:('a t -> 'a t Base.Or_error.t) ->
'a t Base.Or_error.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:Base.int ->
on_empty:('a t -> 'a t Base.Or_error.t) ->
'a t Base.Or_error.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:Base.int ->
on_empty:('a t -> 'a t Base.Or_error.t) ->
'a t Base.Or_error.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 ->
(Base.int, 'a, 'acc, 'final) Zipper_types.fold_outcome Base.Or_error.t) ->
init:'acc ->
finish:('acc -> 'a t -> 'final Base.Or_error.t) ->
'final Base.Or_error.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.