package odig

  1. Overview
  2. Docs

Compilation object indexes

Compilation objects indexes

type 'a t = 'a index

The type for compilation objects indexes whose query results are tagged with 'a.

val empty : 'a index

empty is an empty index.

val of_set : ?init:'a index -> 'a -> set -> 'a index

of_set ~init t s is an index from s whose objects are tagged with t. init is the index to add to (defaults to empty.)

Queries

type query = [
  1. | `Digest of digest
  2. | `Name of string
]

The type for queries. Either by digest or by (capitalized) module name.

val query_of_dep : dep -> query

query_of_dep dep is the most precise query for dep.

val query : 'a t -> query -> ('a * cmi) list * ('a * cmti) list * ('a * cmo) list * ('a * cmx) list * ('a * cmt) list

query i q is (cmis, cmtis, cmos, cmxs, cmt) the compilations objects matching query q in i:

val cmis_for_interface : 'a index -> query -> ('a * cmi) list

cmi_for_interface i q is a list of cmis whose module interface matches q.

val cmtis_for_interface : 'a index -> query -> ('a * cmti) list

cmti_for_interface i q is a list of cmtis whose module interface matches q.

val cmos_for_interface : 'a index -> query -> ('a * cmo) list

cmo_for_interface i d is a list of cmo whose module interface matches q.

val cmxs_for_interface : 'a index -> query -> ('a * cmx) list

cmxs_for_interface i cmx is a list of cmx objects whose module interface matches q.

val cmts_for_interface : 'a index -> query -> ('a * cmt) list

cmxs_for_interface i cmx is a list of cmx objects whose module interface matches q.