package datakit-ci

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package datakit-ci

datakit-ci
- CI_ACL
- CI_cache
  - Make
    
    B
    
    Key
  - Path
- CI_char_stream
- CI_config
- CI_docker
  - Image
- CI_engine
- CI_escape_parser
- CI_eval
  - Make
    
    C
    
    Infix
- CI_form
  - Html
  - State
  - Validator
- CI_git
  - Commit
- CI_history
  - State
- CI_live_log
- CI_log_reporter
- CI_main
- CI_monitored_pool
- CI_output
- CI_process
- CI_result
- CI_s
  - BUILDER
    
    Key
  - CONTEXT
  - TERM
    
    Infix
- CI_secrets
- CI_static
- CI_target
  - Branch_escape
  - Map
  - Set
- CI_term
  - Infix
- CI_utils
  - Client9p
    
    LowLevel
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Infix
  - Log
- CI_web
- CI_web_templates
  - Error
  - Settings
- CI_web_utils
  - Auth
  - Session_data
  - User
  - Wm
    
    resource
  - auth_intro
  - auth_setup
  - form_page
  - github_auth_settings
  - github_callback
  - html_page
  - login_page
  - logout_page
  - post_page
  - protected_page
  - resource
  - resource_with_session
  - static
  - static_crunch
- Datakit_ci
  - ACL
  - BUILDER
    
    Key
  - Cache
    
    Make
    
    B
    
    Key
    
    Path
  - Config
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Docker
    
    Image
  - Git
  - Live_log
  - Monitored_pool
  - Output
  - Private
    
    Client9p
    
    LowLevel
  - Process
  - Target
  - Term
    
    Infix
  - Utils
    
    Infix
  - Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module B : BUILDER

Signature

type t

A t is a cache of values created by B.

val create : logs:Live_log.manager -> B.t -> t

create ~logs b is a fresh cache that maps keys of type B.Key.t to values of type B.value.

val lookup : 
  t ->
  (unit -> DK.t Lwt.t) ->
  B.context ->
  B.Key.t ->
  B.value status Lwt.t

lookup t conn ~rebuild ctx key returns the cached value of key, or uses B.generate ctx key to start the process of calculating the value if this is the first time key has been requested. If rebuild is true then any complete cached result is ignored (we mark the result branch as needing a rebuild and build again anyway).

val find : t -> B.context -> B.Key.t -> B.value Term.t

find t key is the terms which evaluates to the result of looking up key in the cache (using lookup).