val make_with_animation :
Stdlib.Format.formatter ->
make:('seed -> ('result, 'failure) Stdlib.result Lwt.t) ->
on_retry:(Mtime.Span.t -> 'failure -> 'seed Lwt.t) ->
'seed ->
'result Lwt.tmake_with_animation is meant to be used to execute time consuming functions that can be interrupted. Typically proof-of-work tasks. Whilst doing so, it displays a progress animation on the provided formatter (assumes support for '\b`). The animations leave the terminal clean.
make_with_animation ppf ~make ~on_retry seed behaves as follows: (a) if make seed is Ok v (completion of the task), then it returns v (b) if make seed is Error r (task is incomplete), then (b.1) on_retry t r is evaluated where t is the time elapsed during the call to make, and then (b.2) the result is used to attempt the task again.
val display_progress :
?every:int ->
?out:Lwt_unix.file_descr ->
pp_print_step:(Stdlib.Format.formatter -> int -> unit) ->
((unit -> unit Lwt.t) -> 'a Lwt.t) ->
'a Lwt.tdisplay_progress ?every ?out ~pp_print_step f calls pp_print_step when the first argument of f is called and increments the number of steps which will be given to pp_print_step.
If every is passed, it is instead displayed whenever nb_step
mod every = 0 (defaults to 1). Each time pp_print_step is called, the previous output will be erased and replaced by the new output.
pp_print_step must only write on a single-line with no carriage return.