package dune-private-libs

You can search for identifiers within the package.

in-package search v0.2.0

Private libraries of Dune

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (5)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street Group, LLC

Sources

dune-2.5.1.tbz

sha256=8f77d3a87f208e0d7cccaa1c48c4bb1bb87d62d07c3f25e9b8ba298e028ce52b

sha512=f209f12ced10c1abf8782bdb0143f4cec77795f7174d2cc75130afb1e01550b01f2f77b9e3ec4888efdad83d2f9878d179b39126f824f4e522f3ef4da34bf27e

doc/dune-private-libs.cache/Cache/Client/index.html

Module `Cache.Client`

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 -> Cache__.Cache_intf.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 ->
  Stdune.Sexp.t list ->
  repository:int option ->
  duplication:Cache__.Cache_intf.Duplication_mode.t option ->
  (unit, string) Stdune.Result.t

Promote files produced by a build rule into the cache.

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

Find a build rule in the cache by its key.

val retrieve : t -> Cache__.Cache_intf.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 -> Cache__.Cache_intf.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.

val make : 
  ?finally:(unit -> unit) ->
  ?duplication_mode:Cache__.Cache_intf.Duplication_mode.t ->
  command_handler:(Cache__.Cache_intf.command -> unit) ->
  unit ->
  (t, exn) Stdune.Result.t