simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2025-12-17 16:16:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
moonpool/dev/ocaml/Odoc_info/Extension/index.html

2 lines
No EOL
8.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Extension (ocaml.Odoc_info.Extension)</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> &#x00BB; <a href="../index.html">Odoc_info</a> &#x00BB; Extension</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Extension</span></code></h1><p>Representation and manipulation of extensions.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-private_flag"><a href="#type-private_flag" class="anchor"></a><code><span><span class="keyword">type</span> private_flag</span><span> = <a href="../../Odoc_extension/index.html#type-private_flag">Odoc_extension.private_flag</a></span><span> = </span></code><ol><li id="type-private_flag.Private" class="def variant constructor anchored"><a href="#type-private_flag.Private" class="anchor"></a><code><span>| </span><span><span class="constructor">Private</span></span></code></li><li id="type-private_flag.Public" class="def variant constructor anchored"><a href="#type-private_flag.Public" class="anchor"></a><code><span>| </span><span><span class="constructor">Public</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-extension_alias"><a href="#type-extension_alias" class="anchor"></a><code><span><span class="keyword">type</span> extension_alias</span><span> = <a href="../../Odoc_extension/index.html#type-extension_alias">Odoc_extension.extension_alias</a></span><span> = </span><span>{</span></code><ol><li id="type-extension_alias.xa_name" class="def record field anchored"><a href="#type-extension_alias.xa_name" class="anchor"></a><code><span>xa_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The complete name of the target extension.</p><span class="comment-delim">*)</span></div></li><li id="type-extension_alias.xa_xt" class="def record field anchored"><a href="#type-extension_alias.xa_xt" class="anchor"></a><code><span><span class="keyword">mutable</span> xa_xt : <span><a href="#type-t_extension_constructor">t_extension_constructor</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The target extension, if we found it.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Used when the extension is a rebind of another extension, when we have <code>extension Xt = Target_xt</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_extension_constructor"><a href="#type-t_extension_constructor" class="anchor"></a><code><span><span class="keyword">and</span> t_extension_constructor</span><span> = <a href="../../Odoc_extension/index.html#type-t_extension_constructor">Odoc_extension.t_extension_constructor</a></span><span> = </span><span>{</span></code><ol><li id="type-t_extension_constructor.xt_name" class="def record field anchored"><a href="#type-t_extension_constructor.xt_name" class="anchor"></a><code><span>xt_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code></li><li id="type-t_extension_constructor.xt_args" class="def record field anchored"><a href="#type-t_extension_constructor.xt_args" class="anchor"></a><code><span>xt_args : <a href="../../Odoc_type/index.html#type-constructor_args">Odoc_type.constructor_args</a>;</span></code></li><li id="type-t_extension_constructor.xt_ret" class="def record field anchored"><a href="#type-t_extension_constructor.xt_ret" class="anchor"></a><code><span>xt_ret : <span><a href="../../Types/index.html#type-type_expr">Types.type_expr</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the optional return type of the extension</p><span class="comment-delim">*)</span></div></li><li id="type-t_extension_constructor.xt_type_extension" class="def record field anchored"><a href="#type-t_extension_constructor.xt_type_extension" class="anchor"></a><code><span>xt_type_extension : <a href="#type-t_type_extension">t_type_extension</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the type extension containing this constructor</p><span class="comment-delim">*)</span></div></li><li id="type-t_extension_constructor.xt_alias" class="def record field anchored"><a href="#type-t_extension_constructor.xt_alias" class="anchor"></a><code><span>xt_alias : <span><a href="#type-extension_alias">extension_alias</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>None</code> when the extension is not a rebind.</p><span class="comment-delim">*)</span></div></li><li id="type-t_extension_constructor.xt_loc" class="def record field anchored"><a href="#type-t_extension_constructor.xt_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> xt_loc : <a href="../../Odoc_types/index.html#type-location">Odoc_types.location</a>;</span></code></li><li id="type-t_extension_constructor.xt_text" class="def record field anchored"><a href="#type-t_extension_constructor.xt_text" class="anchor"></a><code><span><span class="keyword">mutable</span> xt_text : <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>optional user description</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-t_type_extension"><a href="#type-t_type_extension" class="anchor"></a><code><span><span class="keyword">and</span> t_type_extension</span><span> = <a href="../../Odoc_extension/index.html#type-t_type_extension">Odoc_extension.t_type_extension</a></span><span> = </span><span>{</span></code><ol><li id="type-t_type_extension.te_info" class="def record field anchored"><a href="#type-t_type_extension.te_info" class="anchor"></a><code><span><span class="keyword">mutable</span> te_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_type_extension.te_type_name" class="def record field anchored"><a href="#type-t_type_extension.te_type_name" class="anchor"></a><code><span>te_type_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The type of the extension</p><span class="comment-delim">*)</span></div></li><li id="type-t_type_extension.te_type_parameters" class="def record field anchored"><a href="#type-t_type_extension.te_type_parameters" class="anchor"></a><code><span>te_type_parameters : <span><a href="../../Types/index.html#type-type_expr">Types.type_expr</a> list</span>;</span></code></li><li id="type-t_type_extension.te_private" class="def record field anchored"><a href="#type-t_type_extension.te_private" class="anchor"></a><code><span>te_private : <a href="#type-private_flag">private_flag</a>;</span></code></li><li id="type-t_type_extension.te_constructors" class="def record field anchored"><a href="#type-t_type_extension.te_constructors" class="anchor"></a><code><span><span class="keyword">mutable</span> te_constructors : <span><a href="#type-t_extension_constructor">t_extension_constructor</a> list</span>;</span></code></li><li id="type-t_type_extension.te_loc" class="def record field anchored"><a href="#type-t_type_extension.te_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> te_loc : <a href="../index.html#type-location">location</a>;</span></code></li><li id="type-t_type_extension.te_code" class="def record field anchored"><a href="#type-t_type_extension.te_code" class="anchor"></a><code><span><span class="keyword">mutable</span> te_code : <span>string option</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-extension_constructors"><a href="#val-extension_constructors" class="anchor"></a><code><span><span class="keyword">val</span> extension_constructors : <span><a href="#type-t_type_extension">t_type_extension</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t_extension_constructor">t_extension_constructor</a> list</span></span></code></div><div class="spec-doc"><p>Access to the extensions in a group.</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink