mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 08:06:43 -05:00
29 lines
No EOL
42 KiB
HTML
29 lines
No EOL
42 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Module (ocaml.Odoc_info.Module)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ocaml</a> » <a href="../index.html">Odoc_info</a> » Module</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Module</span></code></h1><p>Representation and manipulation of modules and module types.</p></header><nav class="odoc-toc"><ul><li><a href="#types">Types</a></li><li><a href="#functions-for-modules">Functions for modules</a></li><li><a href="#functions-for-module-types">Functions for module types</a></li></ul></nav><div class="odoc-content"><h2 id="types"><a href="#types" class="anchor"></a>Types</h2><div class="odoc-spec"><div class="spec type anchored" id="type-module_element"><a href="#type-module_element" class="anchor"></a><code><span><span class="keyword">type</span> module_element</span><span> = <a href="../../Odoc_module/index.html#type-module_element">Odoc_module.module_element</a></span><span> = </span></code><ol><li id="type-module_element.Element_module" class="def variant constructor anchored"><a href="#type-module_element.Element_module" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_module</span> <span class="keyword">of</span> <a href="#type-t_module">t_module</a></span></code></li><li id="type-module_element.Element_module_type" class="def variant constructor anchored"><a href="#type-module_element.Element_module_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_module_type</span> <span class="keyword">of</span> <a href="#type-t_module_type">t_module_type</a></span></code></li><li id="type-module_element.Element_included_module" class="def variant constructor anchored"><a href="#type-module_element.Element_included_module" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_included_module</span> <span class="keyword">of</span> <a href="#type-included_module">included_module</a></span></code></li><li id="type-module_element.Element_class" class="def variant constructor anchored"><a href="#type-module_element.Element_class" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_class</span> <span class="keyword">of</span> <a href="../Class/index.html#type-t_class">Class.t_class</a></span></code></li><li id="type-module_element.Element_class_type" class="def variant constructor anchored"><a href="#type-module_element.Element_class_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_class_type</span> <span class="keyword">of</span> <a href="../Class/index.html#type-t_class_type">Class.t_class_type</a></span></code></li><li id="type-module_element.Element_value" class="def variant constructor anchored"><a href="#type-module_element.Element_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_value</span> <span class="keyword">of</span> <a href="../Value/index.html#type-t_value">Value.t_value</a></span></code></li><li id="type-module_element.Element_type_extension" class="def variant constructor anchored"><a href="#type-module_element.Element_type_extension" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_type_extension</span> <span class="keyword">of</span> <a href="../Extension/index.html#type-t_type_extension">Extension.t_type_extension</a></span></code></li><li id="type-module_element.Element_exception" class="def variant constructor anchored"><a href="#type-module_element.Element_exception" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_exception</span> <span class="keyword">of</span> <a href="../Exception/index.html#type-t_exception">Exception.t_exception</a></span></code></li><li id="type-module_element.Element_type" class="def variant constructor anchored"><a href="#type-module_element.Element_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_type</span> <span class="keyword">of</span> <a href="../Type/index.html#type-t_type">Type.t_type</a></span></code></li><li id="type-module_element.Element_module_comment" class="def variant constructor anchored"><a href="#type-module_element.Element_module_comment" class="anchor"></a><code><span>| </span><span><span class="constructor">Element_module_comment</span> <span class="keyword">of</span> <a href="../index.html#type-text">text</a></span></code></li></ol></div><div class="spec-doc"><p>To keep the order of elements in a module.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-mmt"><a href="#type-mmt" class="anchor"></a><code><span><span class="keyword">and</span> mmt</span><span> = <a href="../../Odoc_module/index.html#type-mmt">Odoc_module.mmt</a></span><span> = </span></code><ol><li id="type-mmt.Mod" class="def variant constructor anchored"><a href="#type-mmt.Mod" class="anchor"></a><code><span>| </span><span><span class="constructor">Mod</span> <span class="keyword">of</span> <a href="#type-t_module">t_module</a></span></code></li><li id="type-mmt.Modtype" class="def variant constructor anchored"><a href="#type-mmt.Modtype" class="anchor"></a><code><span>| </span><span><span class="constructor">Modtype</span> <span class="keyword">of</span> <a href="#type-t_module_type">t_module_type</a></span></code></li></ol></div><div class="spec-doc"><p>Used where we can reference t_module or t_module_type.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-included_module"><a href="#type-included_module" class="anchor"></a><code><span><span class="keyword">and</span> included_module</span><span> = <a href="../../Odoc_module/index.html#type-included_module">Odoc_module.included_module</a></span><span> = </span><span>{</span></code><ol><li id="type-included_module.im_name" class="def record field anchored"><a href="#type-included_module.im_name" class="anchor"></a><code><span>im_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the included module.</p><span class="comment-delim">*)</span></div></li><li id="type-included_module.im_module" class="def record field anchored"><a href="#type-included_module.im_module" class="anchor"></a><code><span><span class="keyword">mutable</span> im_module : <span><a href="#type-mmt">mmt</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The included module or module type, if we found it.</p><span class="comment-delim">*)</span></div></li><li id="type-included_module.im_info" class="def record field anchored"><a href="#type-included_module.im_info" class="anchor"></a><code><span><span class="keyword">mutable</span> im_info : <span><a href="../../Odoc_types/index.html#type-info">Odoc_types.info</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>comment associated with the include directive</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-module_alias"><a href="#type-module_alias" class="anchor"></a><code><span><span class="keyword">and</span> module_alias</span><span> = <a href="../../Odoc_module/index.html#type-module_alias">Odoc_module.module_alias</a></span><span> = </span><span>{</span></code><ol><li id="type-module_alias.ma_name" class="def record field anchored"><a href="#type-module_alias.ma_name" class="anchor"></a><code><span>ma_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the target module.</p><span class="comment-delim">*)</span></div></li><li id="type-module_alias.ma_module" class="def record field anchored"><a href="#type-module_alias.ma_module" class="anchor"></a><code><span><span class="keyword">mutable</span> ma_module : <span><a href="#type-mmt">mmt</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The real module or module type if we could associate it.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-module_parameter"><a href="#type-module_parameter" class="anchor"></a><code><span><span class="keyword">and</span> module_parameter</span><span> = <a href="../../Odoc_module/index.html#type-module_parameter">Odoc_module.module_parameter</a></span><span> = </span><span>{</span></code><ol><li id="type-module_parameter.mp_name" class="def record field anchored"><a href="#type-module_parameter.mp_name" class="anchor"></a><code><span>mp_name : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the name</p><span class="comment-delim">*)</span></div></li><li id="type-module_parameter.mp_type" class="def record field anchored"><a href="#type-module_parameter.mp_type" class="anchor"></a><code><span>mp_type : <span><a href="../../Types/index.html#type-module_type">Types.module_type</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the type</p><span class="comment-delim">*)</span></div></li><li id="type-module_parameter.mp_type_code" class="def record field anchored"><a href="#type-module_parameter.mp_type_code" class="anchor"></a><code><span>mp_type_code : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the original code</p><span class="comment-delim">*)</span></div></li><li id="type-module_parameter.mp_kind" class="def record field anchored"><a href="#type-module_parameter.mp_kind" class="anchor"></a><code><span>mp_kind : <a href="#type-module_type_kind">module_type_kind</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the way the parameter was built</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-module_kind"><a href="#type-module_kind" class="anchor"></a><code><span><span class="keyword">and</span> module_kind</span><span> = <a href="../../Odoc_module/index.html#type-module_kind">Odoc_module.module_kind</a></span><span> = </span></code><ol><li id="type-module_kind.Module_struct" class="def variant constructor anchored"><a href="#type-module_kind.Module_struct" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_struct</span> <span class="keyword">of</span> <span><a href="#type-module_element">module_element</a> list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A complete module structure.</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_alias" class="def variant constructor anchored"><a href="#type-module_kind.Module_alias" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_alias</span> <span class="keyword">of</span> <a href="#type-module_alias">module_alias</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name and corresponding module if we found it</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_functor" class="def variant constructor anchored"><a href="#type-module_kind.Module_functor" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_functor</span> <span class="keyword">of</span> <a href="#type-module_parameter">module_parameter</a> * <a href="#type-module_kind">module_kind</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A functor, with its parameter and the rest of its definition</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_apply" class="def variant constructor anchored"><a href="#type-module_kind.Module_apply" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_apply</span> <span class="keyword">of</span> <a href="#type-module_kind">module_kind</a> * <a href="#type-module_kind">module_kind</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A module defined by application of a functor.</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_with" class="def variant constructor anchored"><a href="#type-module_kind.Module_with" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_with</span> <span class="keyword">of</span> <a href="#type-module_type_kind">module_type_kind</a> * string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A module whose type is a with ... constraint. Should appear in interface files only.</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_constraint" class="def variant constructor anchored"><a href="#type-module_kind.Module_constraint" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_constraint</span> <span class="keyword">of</span> <a href="#type-module_kind">module_kind</a> * <a href="#type-module_type_kind">module_type_kind</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A module constraint by a module type.</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_typeof" class="def variant constructor anchored"><a href="#type-module_kind.Module_typeof" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_typeof</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>by now only the code of the module expression</p><span class="comment-delim">*)</span></div></li><li id="type-module_kind.Module_unpack" class="def variant constructor anchored"><a href="#type-module_kind.Module_unpack" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_unpack</span> <span class="keyword">of</span> string * <a href="#type-module_type_alias">module_type_alias</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>code of the expression and module type alias</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Different kinds of a module.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_module"><a href="#type-t_module" class="anchor"></a><code><span><span class="keyword">and</span> t_module</span><span> = <a href="../../Odoc_module/index.html#type-t_module">Odoc_module.t_module</a></span><span> = </span><span>{</span></code><ol><li id="type-t_module.m_name" class="def record field anchored"><a href="#type-t_module.m_name" class="anchor"></a><code><span>m_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the module.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_type" class="def record field anchored"><a href="#type-t_module.m_type" class="anchor"></a><code><span><span class="keyword">mutable</span> m_type : <a href="../../Types/index.html#type-module_type">Types.module_type</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The type of the module.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_info" class="def record field anchored"><a href="#type-t_module.m_info" class="anchor"></a><code><span><span class="keyword">mutable</span> m_info : <span><a href="../index.html#type-info">info</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Information found in the optional associated comment.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_is_interface" class="def record field anchored"><a href="#type-t_module.m_is_interface" class="anchor"></a><code><span>m_is_interface : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> for modules read from interface files</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_file" class="def record field anchored"><a href="#type-t_module.m_file" class="anchor"></a><code><span>m_file : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The file the module is defined in.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_kind" class="def record field anchored"><a href="#type-t_module.m_kind" class="anchor"></a><code><span><span class="keyword">mutable</span> m_kind : <a href="#type-module_kind">module_kind</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The way the module is defined.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_loc" class="def record field anchored"><a href="#type-t_module.m_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> m_loc : <a href="../index.html#type-location">location</a>;</span></code></li><li id="type-t_module.m_top_deps" class="def record field anchored"><a href="#type-t_module.m_top_deps" class="anchor"></a><code><span><span class="keyword">mutable</span> m_top_deps : <span><a href="../Name/index.html#type-t">Name.t</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The toplevels module names this module depends on.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_code" class="def record field anchored"><a href="#type-t_module.m_code" class="anchor"></a><code><span><span class="keyword">mutable</span> m_code : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The whole code of the module</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_code_intf" class="def record field anchored"><a href="#type-t_module.m_code_intf" class="anchor"></a><code><span><span class="keyword">mutable</span> m_code_intf : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The whole code of the interface of the module</p><span class="comment-delim">*)</span></div></li><li id="type-t_module.m_text_only" class="def record field anchored"><a href="#type-t_module.m_text_only" class="anchor"></a><code><span>m_text_only : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the module comes from a text file</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a module.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-module_type_alias"><a href="#type-module_type_alias" class="anchor"></a><code><span><span class="keyword">and</span> module_type_alias</span><span> = <a href="../../Odoc_module/index.html#type-module_type_alias">Odoc_module.module_type_alias</a></span><span> = </span><span>{</span></code><ol><li id="type-module_type_alias.mta_name" class="def record field anchored"><a href="#type-module_type_alias.mta_name" class="anchor"></a><code><span>mta_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the target module type.</p><span class="comment-delim">*)</span></div></li><li id="type-module_type_alias.mta_module" class="def record field anchored"><a href="#type-module_type_alias.mta_module" class="anchor"></a><code><span><span class="keyword">mutable</span> mta_module : <span><a href="#type-t_module_type">t_module_type</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The real module type if we could associate it.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-module_type_kind"><a href="#type-module_type_kind" class="anchor"></a><code><span><span class="keyword">and</span> module_type_kind</span><span> = <a href="../../Odoc_module/index.html#type-module_type_kind">Odoc_module.module_type_kind</a></span><span> = </span></code><ol><li id="type-module_type_kind.Module_type_struct" class="def variant constructor anchored"><a href="#type-module_type_kind.Module_type_struct" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_type_struct</span> <span class="keyword">of</span> <span><a href="#type-module_element">module_element</a> list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A complete module signature.</p><span class="comment-delim">*)</span></div></li><li id="type-module_type_kind.Module_type_functor" class="def variant constructor anchored"><a href="#type-module_type_kind.Module_type_functor" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_type_functor</span> <span class="keyword">of</span> <a href="#type-module_parameter">module_parameter</a> * <a href="#type-module_type_kind">module_type_kind</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A functor, with its parameter and the rest of its definition</p><span class="comment-delim">*)</span></div></li><li id="type-module_type_kind.Module_type_alias" class="def variant constructor anchored"><a href="#type-module_type_kind.Module_type_alias" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_type_alias</span> <span class="keyword">of</span> <a href="#type-module_type_alias">module_type_alias</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete alias name and corresponding module type if we found it.</p><span class="comment-delim">*)</span></div></li><li id="type-module_type_kind.Module_type_with" class="def variant constructor anchored"><a href="#type-module_type_kind.Module_type_with" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_type_with</span> <span class="keyword">of</span> <a href="#type-module_type_kind">module_type_kind</a> * string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The module type kind and the code of the with constraint.</p><span class="comment-delim">*)</span></div></li><li id="type-module_type_kind.Module_type_typeof" class="def variant constructor anchored"><a href="#type-module_type_kind.Module_type_typeof" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_type_typeof</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>by now only the code of the module expression</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Different kinds of module type.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_module_type"><a href="#type-t_module_type" class="anchor"></a><code><span><span class="keyword">and</span> t_module_type</span><span> = <a href="../../Odoc_module/index.html#type-t_module_type">Odoc_module.t_module_type</a></span><span> = </span><span>{</span></code><ol><li id="type-t_module_type.mt_name" class="def record field anchored"><a href="#type-t_module_type.mt_name" class="anchor"></a><code><span>mt_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the module type.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_info" class="def record field anchored"><a href="#type-t_module_type.mt_info" class="anchor"></a><code><span><span class="keyword">mutable</span> mt_info : <span><a href="../index.html#type-info">info</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Information found in the optional associated comment.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_type" class="def record field anchored"><a href="#type-t_module_type.mt_type" class="anchor"></a><code><span><span class="keyword">mutable</span> mt_type : <span><a href="../../Types/index.html#type-module_type">Types.module_type</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>None</code> means that the module type is abstract.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_is_interface" class="def record field anchored"><a href="#type-t_module_type.mt_is_interface" class="anchor"></a><code><span>mt_is_interface : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> for modules read from interface files.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_file" class="def record field anchored"><a href="#type-t_module_type.mt_file" class="anchor"></a><code><span>mt_file : string;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The file the module type is defined in.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_kind" class="def record field anchored"><a href="#type-t_module_type.mt_kind" class="anchor"></a><code><span><span class="keyword">mutable</span> mt_kind : <span><a href="#type-module_type_kind">module_type_kind</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The way the module is defined. <code>None</code> means that module type is abstract. It is always <code>None</code> when the module type was extracted from the implementation file. That means module types are only analysed in interface files.</p><span class="comment-delim">*)</span></div></li><li id="type-t_module_type.mt_loc" class="def record field anchored"><a href="#type-t_module_type.mt_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> mt_loc : <a href="../index.html#type-location">location</a>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a module type.</p></div></div><h2 id="functions-for-modules"><a href="#functions-for-modules" class="anchor"></a>Functions for modules</h2><div class="odoc-spec"><div class="spec value anchored" id="val-module_elements"><a href="#val-module_elements" class="anchor"></a><code><span><span class="keyword">val</span> module_elements : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="#type-module_element">module_element</a> list</span></span></code></div><div class="spec-doc"><p>Access to the elements of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_modules"><a href="#val-module_modules" class="anchor"></a><code><span><span class="keyword">val</span> module_modules : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> list</span></span></code></div><div class="spec-doc"><p>Access to the submodules of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_module_types"><a href="#val-module_module_types" class="anchor"></a><code><span><span class="keyword">val</span> module_module_types : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the module types of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_included_modules"><a href="#val-module_included_modules" class="anchor"></a><code><span><span class="keyword">val</span> module_included_modules : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="#type-included_module">included_module</a> list</span></span></code></div><div class="spec-doc"><p>Access to the included modules of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_extensions"><a href="#val-module_type_extensions" class="anchor"></a><code><span><span class="keyword">val</span> module_type_extensions :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span>
|
||
<span><a href="../Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> list</span></span></code></div><div class="spec-doc"><p>Access to the type extensions of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_exceptions"><a href="#val-module_exceptions" class="anchor"></a><code><span><span class="keyword">val</span> module_exceptions : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Exception/index.html#type-t_exception">Exception.t_exception</a> list</span></span></code></div><div class="spec-doc"><p>Access to the exceptions of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_types"><a href="#val-module_types" class="anchor"></a><code><span><span class="keyword">val</span> module_types : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Type/index.html#type-t_type">Type.t_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the types of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_values"><a href="#val-module_values" class="anchor"></a><code><span><span class="keyword">val</span> module_values : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to the values of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_functions"><a href="#val-module_functions" class="anchor"></a><code><span><span class="keyword">val</span> module_functions : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to functional values of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_simple_values"><a href="#val-module_simple_values" class="anchor"></a><code><span><span class="keyword">val</span> module_simple_values : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to non-functional values of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_classes"><a href="#val-module_classes" class="anchor"></a><code><span><span class="keyword">val</span> module_classes : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Class/index.html#type-t_class">Class.t_class</a> list</span></span></code></div><div class="spec-doc"><p>Access to the classes of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_class_types"><a href="#val-module_class_types" class="anchor"></a><code><span><span class="keyword">val</span> module_class_types : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Class/index.html#type-t_class_type">Class.t_class_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the class types of a module.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_all_classes"><a href="#val-module_all_classes" class="anchor"></a><code><span><span class="keyword">val</span> module_all_classes : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../Class/index.html#type-t_class">Class.t_class</a> list</span></span></code></div><div class="spec-doc"><p>The list of classes defined in this module and all its submodules and functors.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_is_functor"><a href="#val-module_is_functor" class="anchor"></a><code><span><span class="keyword">val</span> module_is_functor : <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>true</code> if the module is functor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_parameters"><a href="#val-module_parameters" class="anchor"></a><code><span><span class="keyword">val</span> module_parameters :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span>
|
||
<span><span>(<a href="#type-module_parameter">module_parameter</a> * <span><a href="../index.html#type-text">text</a> option</span>)</span> list</span></span></code></div><div class="spec-doc"><p>The list of couples (module parameter, optional description).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_comments"><a href="#val-module_comments" class="anchor"></a><code><span><span class="keyword">val</span> module_comments : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-text">text</a> list</span></span></code></div><div class="spec-doc"><p>The list of module comments.</p></div></div><h2 id="functions-for-module-types"><a href="#functions-for-module-types" class="anchor"></a>Functions for module types</h2><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_elements"><a href="#val-module_type_elements" class="anchor"></a><code><span><span class="keyword">val</span> module_type_elements : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="#type-module_element">module_element</a> list</span></span></code></div><div class="spec-doc"><p>Access to the elements of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_modules"><a href="#val-module_type_modules" class="anchor"></a><code><span><span class="keyword">val</span> module_type_modules : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="#type-t_module">t_module</a> list</span></span></code></div><div class="spec-doc"><p>Access to the submodules of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_module_types"><a href="#val-module_type_module_types" class="anchor"></a><code><span><span class="keyword">val</span> module_type_module_types :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the module types of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_included_modules"><a href="#val-module_type_included_modules" class="anchor"></a><code><span><span class="keyword">val</span> module_type_included_modules :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="#type-included_module">included_module</a> list</span></span></code></div><div class="spec-doc"><p>Access to the included modules of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_exceptions"><a href="#val-module_type_exceptions" class="anchor"></a><code><span><span class="keyword">val</span> module_type_exceptions :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="../Exception/index.html#type-t_exception">Exception.t_exception</a> list</span></span></code></div><div class="spec-doc"><p>Access to the exceptions of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_types"><a href="#val-module_type_types" class="anchor"></a><code><span><span class="keyword">val</span> module_type_types : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="../Type/index.html#type-t_type">Type.t_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the types of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_values"><a href="#val-module_type_values" class="anchor"></a><code><span><span class="keyword">val</span> module_type_values : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to the values of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_functions"><a href="#val-module_type_functions" class="anchor"></a><code><span><span class="keyword">val</span> module_type_functions : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to functional values of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_simple_values"><a href="#val-module_type_simple_values" class="anchor"></a><code><span><span class="keyword">val</span> module_type_simple_values :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>Access to non-functional values of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_classes"><a href="#val-module_type_classes" class="anchor"></a><code><span><span class="keyword">val</span> module_type_classes : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="../Class/index.html#type-t_class">Class.t_class</a> list</span></span></code></div><div class="spec-doc"><p>Access to the classes of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_class_types"><a href="#val-module_type_class_types" class="anchor"></a><code><span><span class="keyword">val</span> module_type_class_types :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="../Class/index.html#type-t_class_type">Class.t_class_type</a> list</span></span></code></div><div class="spec-doc"><p>Access to the class types of a module type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_all_classes"><a href="#val-module_type_all_classes" class="anchor"></a><code><span><span class="keyword">val</span> module_type_all_classes :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><a href="../Class/index.html#type-t_class">Class.t_class</a> list</span></span></code></div><div class="spec-doc"><p>The list of classes defined in this module type and all its submodules and functors.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_is_functor"><a href="#val-module_type_is_functor" class="anchor"></a><code><span><span class="keyword">val</span> module_type_is_functor : <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>true</code> if the module type is functor.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_parameters"><a href="#val-module_type_parameters" class="anchor"></a><code><span><span class="keyword">val</span> module_type_parameters :
|
||
<span>?trans:bool <span class="arrow">-></span></span>
|
||
<span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span>
|
||
<span><span>(<a href="#type-module_parameter">module_parameter</a> * <span><a href="../index.html#type-text">text</a> option</span>)</span> list</span></span></code></div><div class="spec-doc"><p>The list of couples (module parameter, optional description).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_type_comments"><a href="#val-module_type_comments" class="anchor"></a><code><span><span class="keyword">val</span> module_type_comments : <span>?trans:bool <span class="arrow">-></span></span> <span><a href="#type-t_module_type">t_module_type</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-text">text</a> list</span></span></code></div><div class="spec-doc"><p>The list of module comments.</p></div></div></div></body></html> |