package current

You can search for identifiers within the package.

in-package search v0.2.0

package current

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

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

type metadata

type results = {

value : unit Current_term.Output.t;
analysis : Analysis.t;
watches : metadata list;
jobs : actions Job_map.t;
(*
The jobs currently being used (whether running or finished).
*)

}

val create : 
  ?config:Config.t ->
  ?trace:(results -> unit Lwt.t) ->
  (unit -> unit term) ->
  t

create pipeline is a new engine running pipeline. The engine will evaluate t's pipeline immediately, and again whenever one of its inputs changes.

val state : t -> results

The most recent results from evaluating the pipeline.

val jobs : results -> actions Job_map.t

val thread : t -> 'a Lwt.t

thread t is the engine's thread. Use this to monitor the engine (in case it crashes).

val actions : metadata -> actions

val job_id : metadata -> job_id option

val config : t -> Config.t

val is_stale : metadata -> bool

is_stale m is true if this job has signalled that it should be re-evaluated. Provided for unit-tests.

val pp_metadata : metadata Fmt.t