package dune-private-libs

You can search for identifiers within the package.

in-package search v0.2.0

dune-private-libs.cache
- Cache
  - Cache
  - Caching
    
    Cache
  - Client
  - Duplication_mode
  - File
  - Key
  - Local
    
    Metadata_file
    
    Trimming_result
  - Messages
dune-private-libs.dune-lang
- Dune_lang
  - Ast
  - Atom
  - Conv
    
    S
  - Cst
  - Decoder
  - Deprecated
  - Encoder
  - Lexer
    
    Token
    
    Comment
  - Parser
    
    Mode
  - Syntax
    
    Error
    
    Version
    
    Infix
    
    Warning
  - Template
  - Versioned_file
    
    First_line
    
    Make
    
    Data
    
    Lang
    
    Instance
    
    S
    
    Lang
    
    Instance
dune-private-libs.dune_csexp
- Dune_csexp
  - Csexp
    
    Make
    
    Sexp
    
    Sexp
dune-private-libs.dune_re
- Dune_re
  - Group
  - Mark
    
    Set
dune-private-libs.dune_util
- Dune_util
  - Log
    
    File
  - Report_error
dune-private-libs.ocaml-config
- Ocaml_config
  - Ccomp_type
  - Origin
  - Os_type
  - Prog_and_args
  - Value
  - Vars
dune-private-libs.stdune
- Stdune
  - Ansi_color
    
    Style
  - Appendable_list
  - Applicative
    
    Id
    
    O
    
    Make
    
    A
    
    O
  - Applicative_intf
    
    S1
    
    O
    
    S1_base
  - Array
  - Bin
  - Bool
  - Bytes
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Console
    
    Backend
    
    S
    
    Status_line
  - Csexp
  - Daemonize
  - Digest
    
    Set
  - Dyn
    
    Encoder
  - Either
  - Env
    
    Map
    
    Multi
    
    Var
    
    Set
  - Exn
  - Exn_with_backtrace
  - Fcntl
  - Fdecl
  - Filename
  - Float
  - Fun
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    S
    
    Map
    
    Multi
    
    Set
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Interned
    
    Make
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    No_interning
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    Settings
  - Interned_intf
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
  - Io
    
    String_path
  - Lexbuf
  - List
  - Loc
    
    Map
    
    Multi
  - Lock_file
  - Map
    
    Key
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Id
    
    O
    
    Make
    
    M
    
    O
  - Monad_intf
    
    S1
    
    O
    
    S1_base
  - Nothing
  - Option
    
    List
    
    O
  - Or_exn
    
    O
  - Ordering
  - Path
    
    Build
    
    Kind
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    External
    
    Map
    
    Multi
    
    Set
    
    Table
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Local_gen
    
    Fix_root
    
    Map
    
    Multi
    
    Root
    
    Set
    
    Table
    
    L
    
    Map
    
    Multi
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Pid
  - Poly
  - Pp
    
    O
  - Proc
  - Result
    
    List
    
    O
    
    Option
  - Scanf
  - Seq
  - Set
    
    Make
    
    Key
    
    M
    
    Multi
    
    S
  - Sexp
  - Signal
  - Spawn
    
    Env
  - Staged
  - String
    
    Map
    
    Multi
    
    Set
    
    Table
  - Sys
  - Table
    
    Key
  - Top_closure
    
    Int
    
    Make
    
    Keys
    
    Monad
    
    O
    
    String
  - Top_closure_intf
    
    Keys
    
    S
  - Tuple
    
    T2
    
    T3
  - Type_eq
    
    Id
  - Unit
  - Univ_map
    
    Key
  - User_error
  - User_message
    
    Print_config
    
    Style
  - User_warning
dune-private-libs.xdg
- Xdg

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

val set_build_dir : t -> Stdune.Path.t -> t

Set the absolute path to the build directory for interpreting relative paths when promoting files.

val with_repositories : t -> repository list -> t

Set all the version controlled repositories in the workspace to be referred to when promoting files.

val promote : 
  t ->
  (Stdune.Path.Build.t * Stdune.Digest.t) list ->
  Key.t ->
  metadata ->
  repository:int option ->
  duplication:Duplication_mode.t option ->
  (unit, string) Stdune.Result.t

Promote files produced by a build rule into the cache.

val search : t -> Key.t -> (metadata * File.t list, string) Stdune.Result.t

Find a build rule in the cache by its key.

val retrieve : t -> File.t -> Stdune.Path.t

Materialise a cached file in the build directory (using Copy or Hardlink as per the duplication mode) and return the path to it.

val deduplicate : t -> File.t -> unit

Deduplicate a file, i.e. replace the file in_the_build_directory with a hardlink to the one in_the_cache if the deduplication mode is set to Hardlink (or do nothing if the mode is Copy).

val teardown : t -> unit

Remove the local cache and disconnect with a distributed cache client if any.