package travesty

  1. Overview
  2. Docs
package travesty
Legend:
Library
Module
Module type
Parameter
Class
Class type

On_option is On_monad specialised to the option monad.

val pop_m : 'a t -> on_empty:('a t -> ('a * 'a t) Base.Option.t) -> ('a * 'a t) Base.Option.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 Base.Option.t) -> 'a Base.Option.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 Base.Option.t) -> 'a t Base.Option.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 Base.Option.t) -> on_empty:('a t -> 'a t Base.Option.t) -> 'a t Base.Option.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:Mark.t -> on_empty:('a t -> 'a t Base.Option.t) -> 'a t Base.Option.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:Mark.t -> on_empty:('a t -> 'a t Base.Option.t) -> 'a t Base.Option.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:Mark.t -> on_empty:('a t -> 'a t Base.Option.t) -> 'a t Base.Option.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 -> (Mark.t, 'a, 'acc, 'final) fold_outcome Base.Option.t) -> init:'acc -> finish:('acc -> 'a t -> 'final Base.Option.t) -> 'final Base.Option.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.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct