moonpool/dev/ocaml/Stdlib/Effect/index.html
2023-08-29 18:39:53 +00:00

2 lines
No EOL
3.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>Effect (ocaml.Stdlib.Effect)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">ocaml</a> &#x00BB; <a href="../index.html">Stdlib</a> &#x00BB; Effect</nav><header class="odoc-preamble"><h1>Module <code><span>Stdlib.Effect</span></code></h1><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The Effect interface may change in incompatible ways in the future.</li></ul><p>Effects.</p><p>See 'Language extensions/Effect handlers' section in the manual.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 5.0</li></ul><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The Effect interface may change in incompatible ways in the future.</li></ul></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> <span>_ t</span></span><span> = </span><span>..</span></code></div><div class="spec-doc"><p>The type of effects.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Unhandled"><a href="#exception-Unhandled" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Unhandled</span> : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span> exn</span></code></div><div class="spec-doc"><p><code>Unhandled e</code> is raised when effect <code>e</code> is performed and there is no handler for it.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Continuation_already_resumed"><a href="#exception-Continuation_already_resumed" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Continuation_already_resumed</span></span></code></div><div class="spec-doc"><p>Exception raised when a continuation is continued or discontinued more than once.</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>perform e</code> performs an effect <code>e</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Unhandled</span> <p>if there is no handler for <code>e</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Deep"><a href="#module-Deep" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Deep/index.html">Deep</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Deep handlers</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Shallow"><a href="#module-Shallow" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Shallow/index.html">Shallow</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>