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

sha256=3dfd00bd4def773239159b17781d02fdbfd8ea191801681a94aa0a5be1d06b7c

sha512=fd64ff8a819b2db2460c06b7fbd5663e2a1941f9e2d4e9b921a3d5f24509fe3be543521fbe1bb6baedad9f62b579aae933efac3903db03a27385233f5461f09c

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.