Skip to content

Commit 06e1a2f

Browse files
author
Pat Hickey
committed
generate markdown
1 parent 567a201 commit 06e1a2f

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

imports.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,27 @@ at once.</p>
1818
<h4><a name="pollable"><code>resource pollable</code></a></h4>
1919
<hr />
2020
<h3>Functions</h3>
21-
<h4><a name="poll_list"><code>poll-list: func</code></a></h4>
21+
<h4><a name="method_pollable.ready"><code>[method]pollable.ready: func</code></a></h4>
22+
<p>Return the readiness of a pollable. This function never blocks.</p>
23+
<p>Returns <code>true</code> when the pollable is ready, and <code>false</code> otherwise.</p>
24+
<h5>Params</h5>
25+
<ul>
26+
<li><a name="method_pollable.ready.self"><code>self</code></a>: borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;</li>
27+
</ul>
28+
<h5>Return values</h5>
29+
<ul>
30+
<li><a name="method_pollable.ready.0"></a> <code>bool</code></li>
31+
</ul>
32+
<h4><a name="method_pollable.block"><code>[method]pollable.block: func</code></a></h4>
33+
<p><code>block</code> returns immediately if the pollable is ready, and otherwise
34+
blocks until ready.</p>
35+
<p>This function is equivalent to calling <code>poll.poll</code> on a list
36+
containing only this pollable.</p>
37+
<h5>Params</h5>
38+
<ul>
39+
<li><a name="method_pollable.block.self"><code>self</code></a>: borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;</li>
40+
</ul>
41+
<h4><a name="poll"><code>poll: func</code></a></h4>
2242
<p>Poll for completion on a set of pollables.</p>
2343
<p>This function takes a list of pollables, which identify I/O sources of
2444
interest, and waits until one or more of the events is ready for I/O.</p>
@@ -34,19 +54,11 @@ the pollables has an error, it is indicated by marking the source as
3454
being reaedy for I/O.</p>
3555
<h5>Params</h5>
3656
<ul>
37-
<li><a name="poll_list.in"><code>in</code></a>: list&lt;borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;&gt;</li>
57+
<li><a name="poll.in"><code>in</code></a>: list&lt;borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;&gt;</li>
3858
</ul>
3959
<h5>Return values</h5>
4060
<ul>
41-
<li><a name="poll_list.0"></a> list&lt;<code>u32</code>&gt;</li>
42-
</ul>
43-
<h4><a name="poll_one"><code>poll-one: func</code></a></h4>
44-
<p>Poll for completion on a single pollable.</p>
45-
<p>This function is similar to <a href="#poll_list"><code>poll-list</code></a>, but operates on only a single
46-
pollable. When it returns, the handle is ready for I/O.</p>
47-
<h5>Params</h5>
48-
<ul>
49-
<li><a name="poll_one.in"><code>in</code></a>: borrow&lt;<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>&gt;</li>
61+
<li><a name="poll.0"></a> list&lt;<code>u32</code>&gt;</li>
5062
</ul>
5163
<h2><a name="wasi:io_streams">Import interface wasi:io/streams</a></h2>
5264
<p>WASI I/O is an I/O abstraction API which is currently focused on providing

0 commit comments

Comments
 (0)