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

Module `Exposed_for_testing.Flow_meter`Source

Sourcetype 'a t

The type of flow meters for some metric: values that compute an online windowed integral of a discrete sequence of (value, time) samples. This is useful for e.g. estimating the download rate of a process given a sequence of progress updates.

Source

val create : 
  clock:(unit -> Mtime.t) ->
  size:int ->
  elt:(module Integer.S with type t = 'a) ->
  'a t

create ~clock ~size ~elt is a flow meter for values of type elt, using a window size of size and the clock function for collecting timestamps for recorded values.

Sourceval record : 'a t -> 'a -> unit

Add a value to the ring buffer.

Sourceval per_second : 'a t -> 'a

Estimate the rate of change of recorded values per second.