package ocp-index

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Lazy trie structure holding the info on all identifiers

type orig_file = private IndexTypes.orig_file =

The type of files we get our data from

exception Bad_format of string

type info = private IndexTypes.info = {

}

Contains the information on a given identifier

and kind = private IndexTypes.kind =

The kind of elements that can be stored in the trie

module Misc : sig ... end

val load : qualify:bool -> string list -> t

val add_file : qualify:bool -> t -> string -> t

Load a single file into a trie

val open_module : ?cleanup_path:bool -> t -> string list -> t

val fully_open_module : 
  ?cleanup_path:bool ->
  qualify:bool ->
  t ->
  string list ->
  t

val alias : ?cleanup_path:bool -> t -> string list -> string list -> t

val all : t -> info list

Returns all bindings in the trie

val get : t -> string -> info

Lookup an identifier in a trie (eg. option or List.map)

val get_all : t -> string -> info list

val complete : t -> ?filter:(info -> bool) -> string -> info list

include module type of IndexOut

module Format : sig ... end

module Print : sig ... end