moonpool/dev/ocaml/Odoc_info/Exception/index.html
2023-08-28 17:11:38 +00:00

2 lines
No EOL
4.6 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>Exception (ocaml.Odoc_info.Exception)</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; Exception</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Exception</span></code></h1><p>Representation and manipulation of exceptions.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-exception_alias"><a href="#type-exception_alias" class="anchor"></a><code><span><span class="keyword">type</span> exception_alias</span><span> = <a href="../../Odoc_exception/index.html#type-exception_alias">Odoc_exception.exception_alias</a></span><span> = </span><span>{</span></code><ol><li id="type-exception_alias.ea_name" class="def record field anchored"><a href="#type-exception_alias.ea_name" class="anchor"></a><code><span>ea_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 exception.</p><span class="comment-delim">*)</span></div></li><li id="type-exception_alias.ea_ex" class="def record field anchored"><a href="#type-exception_alias.ea_ex" class="anchor"></a><code><span><span class="keyword">mutable</span> ea_ex : <span><a href="#type-t_exception">t_exception</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The target exception, 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 exception is a rebind of another exception, when we have <code>exception Ex = Target_ex</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_exception"><a href="#type-t_exception" class="anchor"></a><code><span><span class="keyword">and</span> t_exception</span><span> = <a href="../../Odoc_exception/index.html#type-t_exception">Odoc_exception.t_exception</a></span><span> = </span><span>{</span></code><ol><li id="type-t_exception.ex_name" class="def record field anchored"><a href="#type-t_exception.ex_name" class="anchor"></a><code><span>ex_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code></li><li id="type-t_exception.ex_info" class="def record field anchored"><a href="#type-t_exception.ex_info" class="anchor"></a><code><span><span class="keyword">mutable</span> ex_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_exception.ex_args" class="def record field anchored"><a href="#type-t_exception.ex_args" class="anchor"></a><code><span>ex_args : <a href="../../Odoc_type/index.html#type-constructor_args">Odoc_type.constructor_args</a>;</span></code></li><li id="type-t_exception.ex_ret" class="def record field anchored"><a href="#type-t_exception.ex_ret" class="anchor"></a><code><span>ex_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 exception.</p><span class="comment-delim">*)</span></div></li><li id="type-t_exception.ex_alias" class="def record field anchored"><a href="#type-t_exception.ex_alias" class="anchor"></a><code><span>ex_alias : <span><a href="#type-exception_alias">exception_alias</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>None</code> when the exception is not a rebind.</p><span class="comment-delim">*)</span></div></li><li id="type-t_exception.ex_loc" class="def record field anchored"><a href="#type-t_exception.ex_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> ex_loc : <a href="../index.html#type-location">location</a>;</span></code></li><li id="type-t_exception.ex_code" class="def record field anchored"><a href="#type-t_exception.ex_code" class="anchor"></a><code><span><span class="keyword">mutable</span> ex_code : <span>string option</span>;</span></code></li></ol><code><span>}</span></code></div></div></div></body></html>