package progress

You can search for identifiers within the package.

in-package search v0.2.0

User-definable progress bars

Install

dune-project

Dependency

github.com Readme Changelog Edit opam file Versions (8)

Authors

C

Craig Ferguson <me@craigfe.io>

Maintainers

C

Craig Ferguson <me@craigfe.io>

Sources

progress-0.5.0.tbz

sha256=7f87f0597363928c45ba859ae5a1430f6aa3c29e251ff1a53cf786ed0e045961

sha512=45dee4fe2ae0b7fc3ca675f6e854d738873eb608ef9155ea5d7edac4639c183ae1f512847a1b43bdfc1f4c459e7d5b44d03ee809455797e680f890b33d531367

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

Module `Make.Config`Source

Configuration for progress bar rendering.

Sourcetype t

Source

val v : 
  ?ppf:Format.formatter ->
  ?hide_cursor:bool ->
  ?persistent:bool ->
  ?max_width:int option ->
  ?min_interval:Duration.t option ->
  unit ->
  t

ppf: the formatter to use for rendering. Defaults to Format.err_formatter.

hide_cursor: whether or not to hide the terminal cursor (using the DECTCEM ANSI escape codes) during progress bar rendering. Defaults to true.

persistent: whether or not to retain the final progress bar display in the terminal after rendering has finished. Defaults to true.

max_width: an optional fixed upper bound on the size of a progress bar (in addition to the one by the terminal width). Defaults to None.

min_interval: the minimum time interval between re-renders of the progress bar display (i.e. a debounce threshold). Defaults to 1/60th of a second.

Sourceval (||) : t -> t -> t

Merge two config values, with settings from the left taking priority. That is, a || b contains the configuration of a, with unset defaults taken from b.

Sourcemodule Default : sig ... end

Provides the default values of each of the config parameters.