travesty 0.8.0 · OCaml Package

On_ident is On_monad specialised to the identity monad.

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

package travesty