You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
19 KiB

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Localise (infer.Absint.Localise)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">Absint</a> &#x00BB; Localise</nav><h1>Module <code>Absint.Localise</code></h1></header><aside><p>Support for localisation</p></aside><div class="spec module" id="module-Tags"><a href="#module-Tags" class="anchor"></a><code><span class="keyword">module</span> <a href="Tags/index.html">Tags</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec type" id="type-error_desc"><a href="#type-error_desc" class="anchor"></a><code><span class="keyword">type</span> error_desc</code><code> = </code><code>{</code><table class="record"><tr id="type-error_desc.descriptions" class="anchored"><td class="def field"><a href="#type-error_desc.descriptions" class="anchor"></a><code>descriptions : <span>string list</span>;</code></td></tr><tr id="type-error_desc.tags" class="anchored"><td class="def field"><a href="#type-error_desc.tags" class="anchor"></a><code>tags : <a href="Tags/index.html#type-t">Tags.t</a>;</code></td></tr><tr id="type-error_desc.dotty" class="anchored"><td class="def field"><a href="#type-error_desc.dotty" class="anchor"></a><code>dotty : <span>string option</span>;</code></td></tr></table><code>}</code></dt><dd><p>description field of error messages</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_error_desc"><a href="#val-compare_error_desc" class="anchor"></a><code><span class="keyword">val</span> compare_error_desc : <a href="index.html#type-error_desc">error_desc</a> <span>&#45;&gt;</span> <a href="index.html#type-error_desc">error_desc</a> <span>&#45;&gt;</span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-no_desc"><a href="#val-no_desc" class="anchor"></a><code><span class="keyword">val</span> no_desc : <a href="index.html#type-error_desc">error_desc</a></code></dt><dd><p>empty error description</p></dd></dl><dl><dt class="spec value" id="val-verbatim_desc"><a href="#val-verbatim_desc" class="anchor"></a><code><span class="keyword">val</span> verbatim_desc : string <span>&#45;&gt;</span> <a href="index.html#type-error_desc">error_desc</a></code></dt><dd><p>verbatim desc from a string, not to be used for user-visible descs</p></dd></dl><div class="spec module" id="module-BucketLevel"><a href="#module-BucketLevel" class="anchor"></a><code><span class="keyword">module</span> <a href="BucketLevel/index.html">BucketLevel</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-error_desc_get_bucket"><a href="#val-error_desc_get_bucket" class="anchor"></a><code><span class="keyword">val</span> error_desc_get_bucket : <a href="index.html#type-error_desc">error_desc</a> <span>&#45;&gt;</span> <span>string option</span></code></dt><dd><p>get the bucket value of an error_desc, if any</p></dd></dl><dl><dt class="spec value" id="val-error_desc_set_bucket"><a href="#val-error_desc_set_bucket" class="anchor"></a><code><span class="keyword">val</span> error_desc_set_bucket : <a href="index.html#type-error_desc">error_desc</a> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> <a href="index.html#type-error_desc">error_desc</a></code></dt><dd><p>set the bucket value of an error_desc</p></dd></dl><dl><dt class="spec value" id="val-error_desc_is_reportable_bucket"><a href="#val-error_desc_is_reportable_bucket" class="anchor"></a><code><span class="keyword">val</span> error_desc_is_reportable_bucket : <a href="index.html#type-error_desc">error_desc</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>check if th