mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-10 04:35:44 -04:00
6 lines
6.6 KiB
HTML
6 lines
6.6 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Error (ppxlib.Ppxlib.Location.Error)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><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">Index</a> » <a href="../../../index.html">ppxlib</a> » <a href="../../index.html">Ppxlib</a> » <a href="../index.html">Location</a> » Error</nav><header class="odoc-preamble"><h1>Module <code><span>Location.Error</span></code></h1></header><div class="odoc-content"><p>For a detailed explanation on error reporting, refer to the <a href="../../../good-practices.html#handling_errors" title="handling_errors">relevant</a> part of the tutorial.</p><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../../../Astlib/Location/Error/index.html#type-t">Astlib.Location.Error.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : <span><span class="label">loc</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span class="label">sub</span>:<span><span>(<a href="../index.html#type-t">t</a> * string)</span> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-createf"><a href="#val-createf" class="anchor"></a><code><span><span class="keyword">val</span> createf : <span><span class="label">loc</span>:<a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <a href="../../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a>, unit, <a href="#type-t">t</a>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-format4">format4</a></span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-message"><a href="#val-message" class="anchor"></a><code><span><span class="keyword">val</span> message : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_message"><a href="#val-set_message" class="anchor"></a><code><span><span class="keyword">val</span> set_message : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-register_error_of_exn"><a href="#val-register_error_of_exn" class="anchor"></a><code><span><span class="keyword">val</span> register_error_of_exn : <span><span>(<span>exn <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span>)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Register an exception handler. Exception registered this way will be properly displayed by <code>report_exception</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_exn"><a href="#val-of_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_exn : <span>exn <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_extension"><a href="#val-to_extension" class="anchor"></a><code><span><span class="keyword">val</span> to_extension :
|
||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||
<span>string <a href="../../../Astlib/Location/index.html#type-loc">Astlib.Location.loc</a></span> * <a href="../../../Astlib/Ast_502/Parsetree/index.html#type-payload">Astlib.Ast_502.Parsetree.payload</a></span></code></div><div class="spec-doc"><p>Convert an error to an extension point. The compiler recognizes this and displays the error properly.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-raise"><a href="#val-raise" class="anchor"></a><code><span><span class="keyword">val</span> raise : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Raise a compiler <code>Parsing.Location.Error</code> exception. The composition of <code>Location.Error.createf</code> with <code>Location.Error.raise</code> is the same as <code>Location.raise_errorf</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_loc"><a href="#val-update_loc" class="anchor"></a><code><span><span class="keyword">val</span> update_loc : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Update where the error is located. The old location will be overwritten.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_location"><a href="#val-get_location" class="anchor"></a><code><span><span class="keyword">val</span> get_location : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p>Find out where the error is located.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_extension"><a href="#val-of_extension" class="anchor"></a><code><span><span class="keyword">val</span> of_extension :
|
||
<span><span>(<span>string <a href="../../../Astlib/Location/index.html#type-loc">Astlib.Location.loc</a></span> * <a href="../../../Astlib/Ast_502/Parsetree/index.html#type-payload">Astlib.Ast_502.Parsetree.payload</a>)</span> <span class="arrow">-></span></span>
|
||
<span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p>Convert an extension point to an error. Extension points must have the exact form as created by <code>to_extension</code>.</p></div></div></div></body></html>
|