package tqdm

  1. Overview
  2. Docs
OCaml library for progress bars

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.1b.tar.gz
md5=6a771915d961838305e42ded3a2aa82b
sha512=15030dc123aa42cddff5a853720ca1a000d4f1b7e7fae2caba5509647378e1287574f23d771998627ddab777615af9fb433fa4c36e4c8b9ff93e0e08b10f1816

doc/tqdm/Tqdm/Tqdm/index.html

Module Tqdm.TqdmSource

Sourcetype t
Sourcemodule Style : sig ... end
Sourcemodule Options : sig ... end
Sourceval create : ?options:Options.t -> int -> t

create ?options total creates a new progress bar tied to stdout. The bar reaches 100% when update is called with total.

Sourceval reset : t -> unit

reset t resets the current bar.

Sourceval update : t -> int -> unit

update t v sets the progress bar a value v, the proportion of the bar displayed is v / total where total is the value that has been used to initialize the bar. The bar is then displayed.

Sourceval incr : t -> by:int -> unit

incr t ~by increases the current value stored in t by by.

Sourceval close : t -> unit

close t finalizes the bar and prints a new line.

Sourceval with_bar : ?options:Options.t -> int -> f:(t -> 'a) -> 'a

with_bar total ~f creates a new bar and runs f using it. close is called when f returns or if f raises.