tiny_httpd/ocaml/Path/index.html
2025-03-21 12:40:14 +00:00

2 lines
9.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>Path (ocaml.Path)</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; Path</nav><header class="odoc-preamble"><h1>Module <code><span>Path</span></code></h1></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></code><ol><li id="type-t.Pident" class="def variant constructor anchored"><a href="#type-t.Pident" class="anchor"></a><code><span>| </span><span><span class="constructor">Pident</span> <span class="keyword">of</span> <a href="../Ident/index.html#type-t">Ident.t</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Examples: x, List, int</p><span class="comment-delim">*)</span></div></li><li id="type-t.Pdot" class="def variant constructor anchored"><a href="#type-t.Pdot" class="anchor"></a><code><span>| </span><span><span class="constructor">Pdot</span> <span class="keyword">of</span> <a href="#type-t">t</a> * string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Examples: List.map, Float.Array</p><span class="comment-delim">*)</span></div></li><li id="type-t.Papply" class="def variant constructor anchored"><a href="#type-t.Papply" class="anchor"></a><code><span>| </span><span><span class="constructor">Papply</span> <span class="keyword">of</span> <a href="#type-t">t</a> * <a href="#type-t">t</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Examples: Set.Make(Int), Map.Make(Set.Make(Int))</p><span class="comment-delim">*)</span></div></li><li id="type-t.Pextra_ty" class="def variant constructor anchored"><a href="#type-t.Pextra_ty" class="anchor"></a><code><span>| </span><span><span class="constructor">Pextra_ty</span> <span class="keyword">of</span> <a href="#type-t">t</a> * <a href="#type-extra_ty">extra_ty</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>Pextra_ty (p, extra)</code> are additional paths of types introduced by specific OCaml constructs. See below.</p><span class="comment-delim">*)</span></div></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-extra_ty"><a href="#type-extra_ty" class="anchor"></a><code><span><span class="keyword">and</span> extra_ty</span><span> = </span></code><ol><li id="type-extra_ty.Pcstr_ty" class="def variant constructor anchored"><a href="#type-extra_ty.Pcstr_ty" class="anchor"></a><code><span>| </span><span><span class="constructor">Pcstr_ty</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>Pextra_ty (p, Pcstr_ty c)</code> is the type of the inline record for constructor <code>c</code> inside type <code>p</code>.</p><p>For example, in</p><pre class="language-ocaml"><code> type 'a t = Nil | Cons of {hd : 'a; tl : 'a t}</code></pre><p>The inline record type <code>{hd : 'a; tl : 'a t}</code> cannot be named by the user in the surface syntax, but internally it has the path <code>Pextra_ty (Pident `t`, Pcstr_ty &quot;Cons&quot;)</code>.</p><span class="comment-delim">*)</span></div></li><li id="type-extra_ty.Pext_ty" class="def variant constructor anchored"><a href="#type-extra_ty.Pext_ty" class="anchor"></a><code><span>| </span><span><span class="constructor">Pext_ty</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>Pextra_ty (p, Pext_ty)</code> is the type of the inline record for the extension constructor <code>p</code>.</p><p>For example, in</p><pre class="language-ocaml"><code> type exn += Error of {loc : loc; msg : string}</code></pre><p>The inline record type <code>{loc : loc; msg : string}</code> cannot be named by the user in the surface syntax, but internally it has the path <code>Pextra_ty (Pident `Error`, Pext_ty)</code>.</p><span class="comment-delim">*)</span></div></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-same"><a href="#val-same" class="anchor"></a><code><span><span class="keyword">val</span> same : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><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="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_extra"><a href="#val-compare_extra" class="anchor"></a><code><span><span class="keyword">val</span> compare_extra : <span><a href="#type-extra_ty">extra_ty</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-extra_ty">extra_ty</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_free_opt"><a href="#val-find_free_opt" class="anchor"></a><code><span><span class="keyword">val</span> find_free_opt : <span><span><a href="../Ident/index.html#type-t">Ident.t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Ident/index.html#type-t">Ident.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exists_free"><a href="#val-exists_free" class="anchor"></a><code><span><span class="keyword">val</span> exists_free : <span><span><a href="../Ident/index.html#type-t">Ident.t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-scope"><a href="#val-scope" class="anchor"></a><code><span><span class="keyword">val</span> scope : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flatten"><a href="#val-flatten" class="anchor"></a><code><span><span class="keyword">val</span> flatten : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>[ `Contains_apply <span><span>| `Ok</span> of <a href="../Ident/index.html#type-t">Ident.t</a> * <span>string list</span></span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><span class="optlabel">?paren</span>:<span>(<span>string <span class="arrow">&#45;&gt;</span></span> bool)</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-head"><a href="#val-head" class="anchor"></a><code><span><span class="keyword">val</span> head : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Ident/index.html#type-t">Ident.t</a></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="#type-t">t</a> <a href="../Format_doc/index.html#type-printer">Format_doc.printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-heads"><a href="#val-heads" class="anchor"></a><code><span><span class="keyword">val</span> heads : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Ident/index.html#type-t">Ident.t</a> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-last"><a href="#val-last" class="anchor"></a><code><span><span class="keyword">val</span> last : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_constructor_typath"><a href="#val-is_constructor_typath" class="anchor"></a><code><span><span class="keyword">val</span> is_constructor_typath : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</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="../Stdlib/Map/module-type-S/index.html">Map.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Stdlib/Map/module-type-S/index.html#type-key">key</a> = <a href="#type-t">t</a></span></span></code></div></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="../Stdlib/Set/module-type-S/index.html">Set.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../Stdlib/Set/module-type-S/index.html#type-elt">elt</a> = <a href="#type-t">t</a></span></span></code></div></div></div></body></html>