+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Route (tiny_httpd.Tiny_httpd_core.Route)</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> » <a href="../../index.html">tiny_httpd</a> » <a href="../index.html">Tiny_httpd_core</a> » Route</nav><header class="odoc-preamble"><h1>Module <code><span>Tiny_httpd_core.Route</span></code></h1><p>Routing</p><p>Basic type-safe routing of handlers based on URL paths. This is optional, it is possible to only define the root handler with something like <a href="https://github.com/anuragsoni/routes/">Routes</a>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-comp"><a href="#type-comp" class="anchor"></a><code><span><span class="keyword">type</span> <span>('a, 'b) comp</span></span></code></div><div class="spec-doc"><p>An atomic component of a path</p></div></div><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> <span>('a, 'b) t</span></span></code></div><div class="spec-doc"><p>A route, composed of path components</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-int"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int : <span><span>(<span>int <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-comp">comp</a></span></span></code></div><div class="spec-doc"><p>Matches an integer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string"><a href="#val-string" class="anchor"></a><code><span><span class="keyword">val</span> string : <span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-comp">comp</a></span></span></code></div><div class="spec-doc"><p>Matches a string not containing <code>'/'</code> and binds it as is.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_urlencoded"><a href="#val-string_urlencoded" class="anchor"></a><code><span><span class="keyword">val</span> string_urlencoded : <span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-comp">comp</a></span></span></code></div><div class="spec-doc"><p>Matches a URL-encoded string, and decodes it.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exact"><a href="#val-exact" class="anchor"></a><code><span><span class="keyword">val</span> exact : <span>string <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-comp">comp</a></span></span></code></div><div class="spec-doc"><p><code>exact "s"</code> matches <code>"s"</code> and nothing else.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Matches the empty path.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rest_of_path"><a href="#val-rest_of_path" class="anchor"></a><code><span><span class="keyword">val</span> rest_of_path : <span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Matches a string, even containing <code>'/'</code>. This will match the entirety of the remaining route.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rest_of_path_urlencoded"><a href="#val-rest_of_path_urlencoded" class="anchor"></a><code><span><span class="keyword">val</span> rest_of_path_urlencoded : <span><span>(<span>string <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'a</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Matches a string, even containing <code>'/'</code>, and URL-decode it (piecewise). This will match the entirety of the remaining route.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(@/)"><a href="#val-(@/)" class="anchor"></a><code><span><span class="keyword">val</span> (@/) : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="#type-comp">comp</a></span> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'b</span>, <span class="type-var">'c</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'c</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>comp / route</code> matches <code>"foo/bar/…"</code> iff <code>comp</code> matches <code>"foo"</code>, and <code>route</code> matches <code>"bar/…"</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exact_path"><a href="#val-exact_path" class="anchor"></a><code><span><span class="keyword">val</span> exact_path : <span>string <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>exact_path "foo/bar/..." r</code> is equivalent to <code>exact "foo" @/ exact "bar" @/ ... @/ r</code></p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.11 *</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print the route.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><span><span>(<span class="type-var">_</span>, <span class="type-var">_</span>)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Print the route.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_url"><a href="#val-to_url" class="anchor"></a><code><span><span class="keyword">val</span> to_url : <span><span><span>(<span class="type-var">'a</span>, string)</span> <a href="#type-t">t</a></span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Private_"><a href="#module-Private_" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Private_/index.html">Private_</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
0 commit comments