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/Multi/index.html

Module Make.MultiSource

type 'a reporter := 'a -> unit
Sourcetype ('a, 'b) t

The type of vertical sequences of progress bars. The parameter 'a stores a list of the reporting functions associated with each bar, terminating with 'b. For example:

  (* Single progress bar, taking a [float] value. *)
  (float reporter -> 'b, 'b) t

  (* A two-bar layout, where the top bar takes [int64]s and the bottom one
     takes [string * float] pairs. *)
  (int64 reporter -> (string * float) reporter -> 'b, 'b) t

These reporting functions are supplied when beginning the rendering process.

Sourceval line : 'a Line.t -> ('a reporter -> 'b, 'b) t

Construct a multiple-line layout from a single progress bar line.

Sourceval lines : 'a Line.t list -> ('a reporter list -> 'b, 'b) t

Construct a multiple-line layout from a sequence of lines that all have the same type of reported values.

Sourceval (++) : ('a, 'b) t -> ('b, 'c) t -> ('a, 'c) t

Stack progress bars vertically. a ++ b is a set with a stacked on top of b. The two sections have separate reporting functions, passed consecutively to the with_reporters continuation when rendering.

Sourceval blank : ('a, 'a) t

A blank line, for adding spacing between progress lines.

OCaml

Innovation. Community. Security.