package omod

You can search for identifiers within the package.

in-package search v0.2.0

package omod

omod
- Omod
  - Private
    
    Cmd
    
    File
    
    Fmt
    
    String
    
    Map
    
    Set
    
    Top
    
    TOPDIRS
omod.support
- Omod_ocamlc
  - Cma
  - Cmi
  - Cmo
  - Cmt
  - Cmti
  - Cmx
  - Cmxa
  - Cmxs
  - DOBJ
- Omod_support
  - Cache
  - Cobj
    
    Index
  - Codec
  - Conf
  - Digest
    
    Map
    
    Set
  - Log
  - Pkg
    
    Map
    
    Set

Legend:
Library
Module
Module type
Parameter
Class
Class type

Omod cache.

type t

The type for cached information.

val v : pkgs:Pkg.db -> t

v ~pkgs is a cache with package database pkgs.

val pkgs : t -> Pkg.db

pkgs c is c's package database.

val file : Conf.t -> Omod.fpath

file conf is the cache file in configuration conf.

val read : Conf.t -> force:bool -> err:Log.t -> (t option, string) result

read conf is the cache of configuration conf (if any). If force is true and a cache read error occurs, it is logged on err and Ok None is returned.

val write : Conf.t -> t -> (unit, string) result

write conf c writes the cache c of configuration conf.

val clear : Conf.t -> (unit, string) result

clear conf clears the cache c of configuration conf.

val get : 
  ?err:Log.t ->
  ?note:Log.t ->
  ?progress:bool ->
  Conf.t ->
  force:bool ->
  trust:bool ->
  (t, string) result

get ~err ~note ~progress conf ~force ~trust get the cache of configuration conf, forcing it if force is true and making sure it is fresh unless trust is true, using err to report errors, note to report indexing operations (defaults to Log.nil) and progress to indicate if progress should be reported on note (defaults to false).

val status : ?err:Log.t -> Conf.t -> t option -> Pkg.diff list

status ~err conf c is the status of cache c of configuration conf.

val codec : t Codec.t

codec is a codec for caches.