mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 04:17:56 -04:00
9 lines
7.5 KiB
HTML
9 lines
7.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set_cookie_hdr (cohttp.Cohttp.Cookie.Set_cookie_hdr)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">cohttp</a> » <a href="../../index.html">Cohttp</a> » <a href="../index.html">Cookie</a> » Set_cookie_hdr</nav><header class="odoc-preamble"><h1>Module <code><span>Cookie.Set_cookie_hdr</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><span>{</span></code><ol><li id="type-t.cookie" class="def record field anchored"><a href="#type-t.cookie" class="anchor"></a><code><span>cookie : <a href="../index.html#type-cookie">cookie</a>;</span></code></li><li id="type-t.expiration" class="def record field anchored"><a href="#type-t.expiration" class="anchor"></a><code><span>expiration : <a href="../index.html#type-expiration">expiration</a>;</span></code></li><li id="type-t.domain" class="def record field anchored"><a href="#type-t.domain" class="anchor"></a><code><span>domain : <span>string option</span>;</span></code></li><li id="type-t.path" class="def record field anchored"><a href="#type-t.path" class="anchor"></a><code><span>path : <span>string option</span>;</span></code></li><li id="type-t.secure" class="def record field anchored"><a href="#type-t.secure" class="anchor"></a><code><span>secure : bool;</span></code></li><li id="type-t.http_only" class="def record field anchored"><a href="#type-t.http_only" class="anchor"></a><code><span>http_only : bool;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A header which a server sends to a client to request that the client returns the cookie in future requests, under certain conditions.</p></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../../sexplib0/Sexplib0/Sexpable/module-type-S/index.html">Sexplib0.Sexpable.S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="../../../../sexplib0/Sexplib0/Sexpable/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 value anchored" id="val-t_of_sexp"><a href="#val-t_of_sexp" class="anchor"></a><code><span><span class="keyword">val</span> t_of_sexp : <span><a href="../../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_t"><a href="#val-sexp_of_t" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_t : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../../sexplib0/Sexplib0/Sexp/index.html#type-t">Sexplib0.Sexp.t</a></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||
<span><span class="optlabel">?expiration</span>:<a href="../index.html#type-expiration">expiration</a> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?path</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?domain</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?secure</span>:bool <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?http_only</span>:bool <span class="arrow">-></span></span>
|
||
<span><a href="../index.html#type-cookie">cookie</a> <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-serialize"><a href="#val-serialize" class="anchor"></a><code><span><span class="keyword">val</span> serialize : <span><span class="optlabel">?version</span>:<span>[ `HTTP_1_0 <span>| `HTTP_1_1</span> ]</span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string * string</span></code></div><div class="spec-doc"><p>Return an HTTP header</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-extract"><a href="#val-extract" class="anchor"></a><code><span><span class="keyword">val</span> extract : <span><a href="../../Header/index.html#type-t">Header.t</a> <span class="arrow">-></span></span> <span><span>(string * <a href="#type-t">t</a>)</span> list</span></span></code></div><div class="spec-doc"><p>Return the list of cookies sent by the server</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cookie"><a href="#val-cookie" class="anchor"></a><code><span><span class="keyword">val</span> cookie : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#type-cookie">cookie</a></span></code></div><div class="spec-doc"><p>The name-value binding</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value"><a href="#val-value" class="anchor"></a><code><span><span class="keyword">val</span> value : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>The value</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-expiration"><a href="#val-expiration" class="anchor"></a><code><span><span class="keyword">val</span> expiration : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../index.html#type-expiration">expiration</a></span></code></div><div class="spec-doc"><p>The expiration</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-domain"><a href="#val-domain" class="anchor"></a><code><span><span class="keyword">val</span> domain : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string option</span></span></code></div><div class="spec-doc"><p>The domain for which the cookie is valid, if any</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-path"><a href="#val-path" class="anchor"></a><code><span><span class="keyword">val</span> path : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string option</span></span></code></div><div class="spec-doc"><p>The path for which the cookie is valid, if any</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-secure"><a href="#val-secure" class="anchor"></a><code><span><span class="keyword">val</span> secure : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Has the cookie's secure attribute been set?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http_only"><a href="#val-http_only" class="anchor"></a><code><span><span class="keyword">val</span> http_only : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div></div></body></html>
|