module Plugin_cache

: sig

This cache avoid recompilation of sources if there are no changes in the files. Since we want the side effects to be executed in case of a re-loading, this isn't a cache of dynloading. The purpose of this cache is to speed up the initialization of programs relying on an ml config set up. The cache is meant to be persistent between different executions of the program. Basically, cmxs files are stored in a specific location. This is not a ram cache. This module handles version upgrades. The info file contains the version of the executable using the cache. If the version doesn't match, the cache is deleted (or just skipped if no write access).

type t

Mutable type containing informations about the cached files.

type filename = string

module Sources : sig

type t

end

module Plugin : sig

type t

val cmxs_filename : t -> string

val sources : t -> Sources.t

val was_compiled_by_current_exec : t -> bool

end

module Config : sig

type t

val create : dir:string -> ?max_files:int -> ?readonly:bool -> ?try_old_cache_with_new_exec:bool -> unit -> t

val dir : t -> string

val max_files : t -> int

val readonly : t -> bool

val try_old_cache_with_new_exec : t -> bool

val t_of_sexp : Sexplib.Sexp.t -> t

val sexp_of_t : t -> Sexplib.Sexp.t

end

val create : Config.t -> t Async.Std.Deferred.Or_error.t

loading info and cache initialization, including some clean-up if needed, etc. cleaning old version files if present.

val digest : Ml_bundle.t list -> Sources.t Async.Std.Deferred.Or_error.t

val find : t -> Sources.t -> Plugin.t option

val add : t -> Sources.t -> Plugin_uuid.t -> filename -> unit Async.Std.Deferred.Or_error.t

update the info in the file system, perform some clean-up if needed

val clean : t -> unit Async.Std.Deferred.Or_error.t

release this plugin cache lock

module Digest : sig

Exported to be used in some other part of ocaml_plugin

type t

include Core.Std.Stringable with type t := t

val file : filename -> t Async.Std.Deferred.Or_error.t

val string : string -> t

val t_of_sexp : Sexplib.Sexp.t -> t

val sexp_of_t : t -> Sexplib.Sexp.t

val compare : t -> t -> int

end