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

sha256=7ae7f5c5a2db88107d0b3fd37d5344f066921270a3e74d56dd13457feb9e586e

sha512=3828ac568e447e5f1e59450ee48491c256d8bc77abe234190e14e2db5be7b81f379837083f0eb28ea9572fce2781fd0addd7adc1701947c0b2de9d8319ace042

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.