package progress

  1. Overview
  2. Docs
User-definable progress bars

Install

Dune Dependency

Authors

Maintainers

Sources

terminal-0.2.1.tbz
sha256=7ae7f5c5a2db88107d0b3fd37d5344f066921270a3e74d56dd13457feb9e586e
sha512=3828ac568e447e5f1e59450ee48491c256d8bc77abe234190e14e2db5be7b81f379837083f0eb28ea9572fce2781fd0addd7adc1701947c0b2de9d8319ace042

doc/progress.engine/Progress_engine/Make/Display/index.html

Module Make.DisplaySource

Sourcetype ('a, 'b) t

The type of active progress bar displays. The type parameters 'a and 'b track the types of the reporting functions supplied by reporters (see Multi.t for details).

Sourceval start : ?config:Config.t -> ('a, 'b) Multi.t -> ('a, 'b) t

Initiate rendering of a progress bar display. Raises Failure if there is already an active progress bar display.

Sourceval reporters : ('a, unit) t -> ('a, unit) Reporter.list

reporters d is the list of initial reporting functions belonging to display d.

Note this list does not include any reporters added during progress bar rendering via add_line.

Sourceval tick : (_, _) t -> unit

tick d re-renders the contents of display d without reporting any specific values. This function can be used to update spinners, durations, etc. when there is no actual progress to report.

Sourceval add_line : ?above:int -> (_, _) t -> 'a Line.t -> 'a Reporter.t

Add a line to an ongoing display, and get its reporting function. By default, the line is added to the bottom of the display (above = 0); the ~above argument can be passed to add the line above some number of existing lines.

Sourceval finalise : (_, _) t -> unit

Terminate the given progress bar display. Raises Failure if the display has already been finalised.

OCaml

Innovation. Community. Security.