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

progress-0.1.0.tbz

sha256=1f101c2823d84d4dc8af693d1571ebdd614f30d675f8efeedf0d6c3018f602e2

sha512=663494ac7f4ddcbc130edc90f5ae036ec198b44f826a966fa94edee419ce7d9bb7e00a5c3996eb65b2d8213a3907a05fff60707f828102ef1e5c5133bcd78037

doc/progress.unix/Progress_unix/index.html

Module `Progress_unix`Source

This module defines Unix-specific extensions to the Progress library.

It is packaged as the Dune library progress.unix.

Time-sensitive segments

Sourceval stopwatch : unit -> 'a Progress.Segment.t

Displays the time for which the bar has been rendering in MM:SS form.

Source

val counter : 
  total:int64 ->
  ?mode:[ `ASCII | `UTF8 ] ->
  ?message:string ->
  ?pp:(int64, int64 Progress.Segment.t) Progress.Units.pp_fixed ->
  ?width:int ->
  ?sampling_interval:int ->
  unit ->
  (int64 -> unit) Progress.t

counter ~total () is a progress bar of the form:

  <message?>  <count?>  MM:SS  [########..............................]  XX%

This is an equivalent of Progress.counter with an extra stopwatch segment.

TTY-sensitive renderers

Sourceval stderr_if_tty : Format.formatter

A formatter that is equal to Format.err_formatter if stdout is a TTY, and is a noop formatter otherwise.

Renderers that use stderr_if_tty as an output formatter.

Sourceval with_display : 'a Progress.t -> ('a -> 'b) -> 'b

Sourceval start : 'a Progress.t -> 'a * Progress.display

Sourceval finalise : Progress.display -> unit

Re-exports

Convenient aliases to functions defined in Progress.

Sourceval (/) : 'a Progress.t -> 'b Progress.t -> ('a * 'b) Progress.t

On This Page

Time-sensitive segments
TTY-sensitive renderers
Re-exports