package current

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Stats

package current

current
- Current
  - Analysis
  - Config
  - Db
  - Engine
    
    Step
  - Job
  - Level
  - Log_matcher
  - Metadata
  - Monitor
  - Pool
  - Primitive
  - Process
  - String
  - Switch
  - Syntax
  - Unit
  - Var
    
    T
  - actions
current.cache
- Current_cache
  - Db
  - Generic
    
    Op
    
    Key
    
    Outcome
    
    Value
  - Make
    
    B
    
    Key
    
    Value
  - Output
    
    P
    
    Key
    
    Outcome
    
    Value
  - S
    
    BUILDER
    
    Key
    
    Value
    
    GENERIC
    
    Key
    
    Outcome
    
    Value
    
    OPERATION
    
    Key
    
    PUBLISHER
    
    Key
    
    Outcome
    
    Value
    
    WITH_DIGEST
    
    WITH_MARSHAL
  - Schedule
current.fs
- Current_fs
current.term
- Current_term
  - Make
    
    Analysis
    
    Executor
    
    Metadata
    
    Syntax
  - Output
  - S
    
    ANALYSIS
    
    EXECUTOR
    
    ORDERED
    
    T
    
    TERM
    
    Syntax

Legend:
Library
Module
Module type
Parameter
Class
Class type

Diagram generation, introspection, and statistics.

val metadata : 'a t -> Metadata.t option t

metadata t is the metadata of t, if any. Raises an exception if t is not a primitive (or a map of one).

val pp : _ t Fmt.t

pp formats a t as a simple string.

val pp_dot : 
  env:(string * string) list ->
  collapse_link:(k:string -> v:string -> string option) ->
  job_info:(Metadata.t -> Current_term.Output.active option * string option) ->
  _ t Fmt.t

pp_dot ~env ~collapse_link ~job_info formats a t as a graphviz dot graph.

parameter env
A list of key-value pairs from the URL to control rendering.

parameter collapse_link
Should return a link to the same page with "?k=v" added to the environment.

parameter job_info
Get update statuses and URLs for links to jobs. The update status is used if the job is rebuilding while showing the output of a previous run. The box is displayed using a gradient from the update status colour to the current output colour.

Stats

val stat : _ t -> Current_term.S.stats

stat t count how many stages are in each state. This can be slow for large pipelines. Consider using quick_stat instead.

val quick_stat : unit -> Current_term.S.stats

quick_stat () returns the current values of the counters. This is O(1). It only counts some operations (binds, primitives and of_output).