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.2.2.tbz

sha256=3341c21923a21cd6b5b5cfa9ec3981f59572c367940fe5e02450533dfb4110b5

sha512=3edbe5ca6ea0bbc678b7dc4abe38bb4c3c4832de0144cc6e0791678712931fbaf2f7141196fca3fdc13a20777851cadcd165bf30c11d92193eecbd8f2d9dbf15

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.