simon/tiny_httpd
1
0
Fork 0
mirror of https://github.com/c-cube/tiny_httpd.git synced 2026-01-22 09:26:41 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
tiny_httpd/ocaml/Shape/Uid/index.html
c-cube 8e524924a5 deploy: f3461cfd21
2025-03-21 12:40:14 +00:00

2 lines
12 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>Uid (ocaml.Shape.Uid)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.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> &#x00BB; <a href="../../index.html">ocaml</a> &#x00BB; <a href="../index.html">Shape</a> &#x00BB; Uid</nav><header class="odoc-preamble"><h1>Module <code><span>Shape.Uid</span></code></h1><p>A <code>Uid.t</code> is associated to every declaration in signatures and implementations. They uniquely identify bindings in the program. When associated with these bindings' locations they are useful to external tools when trying to jump to an identifier's declaration or definition. They are stored to that effect in the <code>uid_to_decl</code> table of cmt files.</p></header><div class="odoc-content"><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> = <span class="keyword">private</span> </span></code><ol><li id="type-t.Compilation_unit" class="def variant constructor anchored"><a href="#type-t.Compilation_unit" class="anchor"></a><code><span>| </span><span><span class="constructor">Compilation_unit</span> <span class="keyword">of</span> string</span></code></li><li id="type-t.Item" class="def variant constructor anchored"><a href="#type-t.Item" class="anchor"></a><code><span>| </span><span><span class="constructor">Item</span> <span class="keyword">of</span> </span><span>{</span></code><ol><li id="type-t.comp_unit" class="def record field anchored"><a href="#type-t.comp_unit" class="anchor"></a><code><span>comp_unit : string;</span></code></li><li id="type-t.id" class="def record field anchored"><a href="#type-t.id" class="anchor"></a><code><span>id : int;</span></code></li><li id="type-t.from" class="def record field anchored"><a href="#type-t.from" class="anchor"></a><code><span>from : <a href="../../Unit_info/index.html#type-intf_or_impl">Unit_info.intf_or_impl</a>;</span></code></li></ol><code><span>}</span></code></li><li id="type-t.Internal" class="def variant constructor anchored"><a href="#type-t.Internal" class="anchor"></a><code><span>| </span><span><span class="constructor">Internal</span></span></code></li><li id="type-t.Predef" class="def variant constructor anchored"><a href="#type-t.Predef" class="anchor"></a><code><span>| </span><span><span class="constructor">Predef</span> <span class="keyword">of</span> string</span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reinit"><a href="#val-reinit" class="anchor"></a><code><span><span class="keyword">val</span> reinit : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk"><a href="#val-mk" class="anchor"></a><code><span><span class="keyword">val</span> mk : <span><span class="label">current_unit</span>:<span><a href="../../Unit_info/index.html#type-t">Unit_info.t</a> option</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_compilation_unit_id"><a href="#val-of_compilation_unit_id" class="anchor"></a><code><span><span class="keyword">val</span> of_compilation_unit_id : <span><a href="../../Ident/index.html#type-t">Ident.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_predef_id"><a href="#val-of_predef_id" class="anchor"></a><code><span><span class="keyword">val</span> of_predef_id : <span><a href="../../Ident/index.html#type-t">Ident.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-internal_not_actually_unique"><a href="#val-internal_not_actually_unique" class="anchor"></a><code><span><span class="keyword">val</span> internal_not_actually_unique : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-for_actual_declaration"><a href="#val-for_actual_declaration" class="anchor"></a><code><span><span class="keyword">val</span> for_actual_declaration : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../Identifiable/module-type-S/index.html">Identifiable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Identifiable/module-type-S/index.html#type-t">t</a> := <a href="#type-t">t</a></span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-T"><a href="#module-T" class="anchor"></a><code><span><span class="keyword">module</span> <a href="T/index.html">T</a></span><span> : <a href="../../Identifiable/module-type-Thing/index.html">Identifiable.Thing</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Identifiable/module-type-Thing/index.html#type-t">t</a> = <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../Identifiable/module-type-Thing/index.html">Identifiable.Thing</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Identifiable/module-type-Thing/index.html#type-t">t</a> := <a href="T/index.html#type-t">T.t</a></span></span></code></summary><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../Stdlib/Hashtbl/module-type-HashedType/index.html">Hashtbl.HashedType</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Stdlib/Hashtbl/module-type-HashedType/index.html#type-t">t</a> := <a href="T/index.html#type-t">T.t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>The equality predicate used to compare keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>A hashing function on keys. It must be such that if two keys are equal according to <code>equal</code>, then they have identical hash values as computed by <code>hash</code>. Examples: suitable (<code>equal</code>, <code>hash</code>) pairs for arbitrary key types include</p><ul><li>(<code>(=)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure (provided objects do not contain floats)</li><li>(<code>(fun x y -&gt; compare x y = 0)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by structure and handling <a href="../../Stdlib/index.html#val-nan"><code>Stdlib.nan</code></a> correctly</li><li>(<code>(==)</code>, <a href="#val-hash"><code>hash</code></a>) for comparing objects by physical equality (e.g. for mutable or cyclic objects).</li></ul></div></div></details></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../Stdlib/Map/module-type-OrderedType/index.html">Map.OrderedType</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../Stdlib/Map/module-type-OrderedType/index.html#type-t">t</a> := <a href="T/index.html#type-t">T.t</a></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>A total ordering function over the keys. This is a two-argument function <code>f</code> such that <code>f e1 e2</code> is zero if the keys <code>e1</code> and <code>e2</code> are equal, <code>f e1 e2</code> is strictly negative if <code>e1</code> is smaller than <code>e2</code>, and <code>f e1 e2</code> is strictly positive if <code>e1</code> is greater than <code>e2</code>. Example: a suitable ordering function is the generic structural comparison function <a href="../../Stdlib/index.html#val-compare"><code>Stdlib.compare</code></a>.</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-output"><a href="#val-output" class="anchor"></a><code><span><span class="keyword">val</span> output : <span><a href="../../Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print"><a href="#val-print" class="anchor"></a><code><span><span class="keyword">val</span> print : <span><a href="../../Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></details></div><div class="odoc-spec"><div class="spec module anchored" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Set/index.html">Set</a></span><span> : <a href="../../Identifiable/module-type-Set/index.html">Identifiable.Set</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="../../Identifiable/module-type-Set/T/index.html">T</a> := <a href="T/index.html">T</a></span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Map"><a href="#module-Map" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Map/index.html">Map</a></span><span> : <a href="../../Identifiable/module-type-Map/index.html">Identifiable.Map</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="../../Identifiable/module-type-Map/T/index.html">T</a> := <a href="T/index.html">T</a></span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Tbl"><a href="#module-Tbl" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Tbl/index.html">Tbl</a></span><span> : <a href="../../Identifiable/module-type-Tbl/index.html">Identifiable.Tbl</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="../../Identifiable/module-type-Tbl/T/index.html">T</a> := <a href="T/index.html">T</a></span></span></code></div></div></details></div></div></body></html>
Reference in a new issue View git blame Copy permalink