File: React.Step.html

package info (click to toggle)
react 1.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,136 kB
  • ctags: 655
  • sloc: ml: 3,843; makefile: 27
file content (55 lines) | stat: -rw-r--r-- 3,088 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="React.S.html">
<link rel="Up" href="React.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="React" rel="Chapter" href="React.html"><link title="Steps" rel="Section" href="#1_Steps">
<title>React.Step</title>
</head>
<body>
<div class="navbar"><a class="pre" href="React.S.html" title="React.S">Previous</a>
&nbsp;<a class="up" href="React.html" title="React">Up</a>
&nbsp;</div>
<h1>Module <a href="type_React.Step.html">React.Step</a></h1>

<pre><span class="keyword">module</span> Step: <code class="code"><span class="keyword">sig</span></code> <a href="React.Step.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Update steps.
<p>

    Update functions returned by <a href="React.S.html#VALcreate"><code class="code"><span class="constructor">React</span>.<span class="constructor">S</span>.create</code></a> and <a href="React.E.html#VALcreate"><code class="code"><span class="constructor">React</span>.<span class="constructor">E</span>.create</code></a>
    implicitely create and execute update steps when used without
    specifying their <code class="code">step</code> argument.
<p>

    Using explicit <a href="React.html#TYPEstep"><code class="code"><span class="constructor">React</span>.step</code></a> values with these functions gives more control on
    the time when the update step is perfomed and allows to perform
    simultaneous <a href="React.html#primitives">primitive</a> signal updates and event
    occurences. See also the documentation about <a href="React.html#steps">update steps</a> and
    <a href="React.html#simultaneity">simultaneous events</a>.<br>
</div>
<hr width="100%">
<br>
<h1 id="1_Steps">Steps</h1><br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type"><a href="React.html#TYPEstep">React.step</a></code> </pre>
<div class="info ">
The type for update steps.<br>
</div>


<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">unit -> <a href="React.html#TYPEstep">React.step</a></code></pre><div class="info ">
<code class="code">create ()</code> is a new update step.<br>
</div>

<pre><span id="VALexecute"><span class="keyword">val</span> execute</span> : <code class="type"><a href="React.html#TYPEstep">React.step</a> -> unit</code></pre><div class="info ">
<code class="code">execute step</code> executes the update step.<br>
<b>Raises</b> <code>Invalid_argument</code> if <code class="code">step</code> was already executed.<br>
</div>
</body></html>