package progress

You can search for identifiers within the package.

in-package search v0.2.0

User-definable progress bars

Install

Dune Dependency

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

Authors

C

Craig Ferguson <me@craigfe.io>

Maintainers

C

Craig Ferguson <me@craigfe.io>

Sources

terminal-0.2.0.tbz

sha256=7a92f6aede3d5010a30e6e47ccbc8380cc5bece8ac95c508323eb25272e6ddd3

sha512=a2ccea467e2d0e419b569992102bd2c43ff97b47f7f8413ee8fbe775ce369a80ff11e0a8fd450ebf1776f7c65baf2482076a120318c9d818488ceba0b9196639

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.