package progress

You can search for identifiers within the package.

in-package search v0.2.0

progress
- Progress
  - Config
    
    Default
  - Display
  - Duration
    
    Of_int
  - Line
    
    Bar_style
    
    Integer_dependent
    
    Ext
    
    Bar_style
    
    Make
    
    Integer
    
    S
    
    Internals
    
    Line_buffer
    
    Span
    
    Using_float
    
    Bar_style
    
    Using_int32
    
    Bar_style
    
    Using_int63
    
    Bar_style
    
    Using_int64
    
    Bar_style
  - Multi
  - Printer
    
    Internals
  - Reporter
  - Units
    
    Bytes
    
    Duration
    
    Percentage
progress.engine
- Progress_engine
  - Exposed_for_testing
    
    Flow_meter
  - Integer
    
    Float
    
    Int
    
    Int32
    
    Int63
    
    Int64
    
    S
  - Make
    
    Config
    
    Default
    
    Display
    
    Duration
    
    Of_int
    
    Line
    
    Bar_style
    
    Integer_dependent
    
    Ext
    
    Bar_style
    
    Make
    
    Integer
    
    S
    
    Internals
    
    Line_buffer
    
    Span
    
    Using_float
    
    Bar_style
    
    Using_int32
    
    Bar_style
    
    Using_int63
    
    Bar_style
    
    Using_int64
    
    Bar_style
    
    Multi
    
    Printer
    
    Internals
    
    Reporter
    
    Units
    
    Bytes
    
    Duration
    
    Percentage
    
    _
    
    Clock
    
    Terminal_width
  - Platform
    
    Clock
    
    Terminal_width
  - S
    
    Config
    
    Default
    
    Display
    
    Duration
    
    Of_int
    
    Line
    
    Bar_style
    
    Integer_dependent
    
    Ext
    
    Bar_style
    
    Make
    
    Integer
    
    S
    
    Internals
    
    Line_buffer
    
    Span
    
    Using_float
    
    Bar_style
    
    Using_int32
    
    Bar_style
    
    Using_int63
    
    Bar_style
    
    Using_int64
    
    Bar_style
    
    Multi
    
    Printer
    
    Internals
    
    Reporter
    
    Units
    
    Bytes
    
    Duration
    
    Percentage

Legend:
Library
Module
Module type
Parameter
Class
Class type

type '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.

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.

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

Add a value to the ring buffer.

val per_second : 'a t -> float

Estimate the rate of change of recorded values per second.