package bechamel

  1. Overview
  2. Docs

Module Bechamel.MeasureSource

Sourcetype 'a impl = (module S.MEASURE with type witness = 'a)

Type of module implementation to record a measure.

Sourcetype 'a measure

Type of measure. 'a represents the witness to record the measure.

Sourcetype witness

Abstract type of a witness to be able to record a measure.

Sourceval register : 'w impl -> 'w measure

register (module Measure) registers a implementation to record a specific measure. The implementation will be globally accessible.

Sourceval instance : 'w impl -> 'w measure -> witness

instance (module Measure) measure returns a value which is able to introspect a measure measure.

Sourceval load : witness -> unit

load w signals to the operating-system to allocate resources needed to record the underlying measure.

Sourceval unload : witness -> unit

unload w releases the operating-system's resources used record the underlying measure.

Sourceval label : witness -> string

label w is the name of the underlying measure represented by w.

Sourceval unit : witness -> string
Sourcetype value =
  1. | V : 'w * 'w impl -> value
Sourceval prj : witness -> value
Sourceval run : string
OCaml

Innovation. Community. Security.