package ocp-index

  1. Overview
  2. Docs
Lightweight completion and documentation browsing for OCaml libraries

Install

Dune Dependency

www.typerex.org Readme Changelog Edit opam file Versions (13)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

1.3.2.tar.gz
md5=8ade4807d4ed12b824fc060de06c7c1b
sha512=40c8609100dc733b49ba09fb2f6d647fcf9e943d1b97551fef8daae79cdb215c37a12f93e1b19f8ac3f4624b324bc128f88967c40e27555c0dbfd93ba23c0eef

doc/ocp-index.lib/IndexTypes/index.html

Module IndexTypes

type ty = Outcometree.out_sig_item

Internal representation of types

type orig_file =
  1. | Cmt of string
  2. | Cmti of string
  3. | Cmi of string

The type of files we get our data from

type info = {
  1. path : string list;
  2. orig_path : string list;
  3. kind : kind;
  4. name : string;
  5. ty : ty option;
  6. loc_sig : Location.t Lazy.t;
  7. loc_impl : Location.t Lazy.t;
  8. doc : string option Lazy.t;
  9. file : orig_file;
}

Contains the information on a given identifier

and kind =
  1. | Type
  2. | Value
  3. | Exception
  4. | OpenType
  5. | Field of info
  6. | Variant of info
  7. | Method of info
  8. | Module
  9. | ModuleType
  10. | Class
  11. | ClassType
  12. | Keyword

The kind of elements that can be stored in the trie

type t = (char, info) IndexTrie.t

Lazy trie structure holding the info on all identifiers

exception Bad_format of string
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct