mirror of
https://github.com/ocaml-tracing/ocaml-trace.git
synced 2026-03-09 20:33:34 -04:00
14 lines
No EOL
5.9 KiB
HTML
14 lines
No EOL
5.9 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Cookies (ppxlib.Ppxlib.Driver.Cookies)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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">ppxlib</a> » <a href="../../index.html">Ppxlib</a> » <a href="../index.html">Driver</a> » Cookies</nav><header class="odoc-preamble"><h1>Module <code><span>Driver.Cookies</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></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get :
|
||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<span><span><span>(<a href="../../../Astlib/Ast_500/Parsetree/index.html#type-expression">Astlib.Ast_500.Parsetree.expression</a>, <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../../Ast_pattern/index.html#type-t">Ast_pattern.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span class="type-var">'b</span> option</span></span></code></div><div class="spec-doc"><p><code>get cookies name pattern</code> look for a cookie named <code>name</code> and parse it using <code>pattern</code>. Raises if the parsing fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_res"><a href="#val-get_res" class="anchor"></a><code><span><span class="keyword">val</span> get_res :
|
||
<span><a href="#type-t">t</a> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<span><span><span>(<a href="../../../Astlib/Ast_500/Parsetree/index.html#type-expression">Astlib.Ast_500.Parsetree.expression</a>, <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../../Ast_pattern/index.html#type-t">Ast_pattern.t</a></span> <span class="arrow">-></span></span>
|
||
<span><span>(<span><span class="type-var">'b</span> option</span>, <span><a href="../../Location/Error/index.html#type-t">Location.Error.t</a> <a href="../../../Stdppx/NonEmptyList/index.html#type-t">Stdppx.NonEmptyList.t</a></span>)</span> <a href="../../../../ocaml/Stdlib/index.html#type-result">result</a></span></span></code></div><div class="spec-doc"><p><code>get cookies name pattern</code> look for a cookie named <code>name</code> and parse it using <code>pattern</code>, returning a <code>result</code> instead of raising when the parsing fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><a href="../../../Astlib/Ast_500/Parsetree/index.html#type-expression">Astlib.Ast_500.Parsetree.expression</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>set cookies name expr</code> set cookie <code>name</code> to <code>expr</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_handler"><a href="#val-add_handler" class="anchor"></a><code><span><span class="keyword">val</span> add_handler : <span><span>(<span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Register a callback that is called before a rewriting. The handler is expected to lookup some cookies and set some global variables.</p><p>This API is a temporary hack to allow to migrate from <code>add_arg</code> to the use of cookie, until ppxlib has been upgraded to pass cookies through.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_simple_handler"><a href="#val-add_simple_handler" class="anchor"></a><code><span><span class="keyword">val</span> add_simple_handler :
|
||
<span>string <span class="arrow">-></span></span>
|
||
<span><span><span>(<a href="../../../Astlib/Ast_500/Parsetree/index.html#type-expression">Astlib.Ast_500.Parsetree.expression</a>, <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../../Ast_pattern/index.html#type-t">Ast_pattern.t</a></span> <span class="arrow">-></span></span>
|
||
<span>f:<span>(<span><span><span class="type-var">'b</span> option</span> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Shorthand for: <code>add_handler (fun t -> f (get t name pattern))</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_post_handler"><a href="#val-add_post_handler" class="anchor"></a><code><span><span class="keyword">val</span> add_post_handler : <span><span>(<span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit)</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Register a callback that is called after a rewriting. The handler is expected to set some cookies from some global variables.</p></div></div></div></body></html> |