Skip to content

Commit 3180d00

Browse files
author
Pat Hickey
committed
generate markdown
1 parent 76eb886 commit 3180d00

File tree

1 file changed

+38
-28
lines changed

1 file changed

+38
-28
lines changed

imports.md

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,37 @@
22
<ul>
33
<li>Imports:
44
<ul>
5-
<li>interface <a href="#wasi:io_poll"><code>wasi:io/poll</code></a></li>
6-
<li>interface <a href="#wasi:io_streams"><code>wasi:io/streams</code></a></li>
7-
<li>interface <a href="#wasi:clocks_wall_clock"><code>wasi:clocks/wall-clock</code></a></li>
8-
<li>interface <a href="#wasi:filesystem_types"><code>wasi:filesystem/types</code></a></li>
9-
<li>interface <a href="#wasi:filesystem_preopens"><code>wasi:filesystem/preopens</code></a></li>
5+
<li>interface <a href="#wasi:io_error_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li>
6+
<li>interface <a href="#wasi:io_poll_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li>
7+
<li>interface <a href="#wasi:io_streams_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li>
8+
<li>interface <a href="#wasi:clocks_wall_clock_0.2.0_rc_2023_11_10"><code>wasi:clocks/[email protected]</code></a></li>
9+
<li>interface <a href="#wasi:filesystem_types_0.2.0_rc_2023_11_10"><code>wasi:filesystem/[email protected]</code></a></li>
10+
<li>interface <a href="#wasi:filesystem_preopens_0.2.0_rc_2023_11_10"><code>wasi:filesystem/[email protected]</code></a></li>
1011
</ul>
1112
</li>
1213
</ul>
13-
<h2><a name="wasi:io_poll">Import interface wasi:io/poll</a></h2>
14+
<h2><a name="wasi:io_error_0.2.0_rc_2023_11_10">Import interface wasi:io/[email protected]</a></h2>
15+
<hr />
16+
<h3>Types</h3>
17+
<h4><a name="error"><code>resource error</code></a></h4>
18+
<hr />
19+
<h3>Functions</h3>
20+
<h4><a name="method_error.to_debug_string"><code>[method]error.to-debug-string: func</code></a></h4>
21+
<p>Returns a string that is suitable to assist humans in debugging
22+
this error.</p>
23+
<p>WARNING: The returned string should not be consumed mechanically!
24+
It may change across platforms, hosts, or other implementation
25+
details. Parsing this string is a major platform-compatibility
26+
hazard.</p>
27+
<h5>Params</h5>
28+
<ul>
29+
<li><a name="method_error.to_debug_string.self"><code>self</code></a>: borrow&lt;<a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
30+
</ul>
31+
<h5>Return values</h5>
32+
<ul>
33+
<li><a name="method_error.to_debug_string.0"></a> <code>string</code></li>
34+
</ul>
35+
<h2><a name="wasi:io_poll_0.2.0_rc_2023_11_10">Import interface wasi:io/[email protected]</a></h2>
1436
<p>A poll API intended to let users wait for I/O events on multiple handles
1537
at once.</p>
1638
<hr />
@@ -60,18 +82,20 @@ being reaedy for I/O.</p>
6082
<ul>
6183
<li><a name="poll.0"></a> list&lt;<code>u32</code>&gt;</li>
6284
</ul>
63-
<h2><a name="wasi:io_streams">Import interface wasi:io/streams</a></h2>
85+
<h2><a name="wasi:io_streams_0.2.0_rc_2023_11_10">Import interface wasi:io/streams@0.2.0-rc-2023-11-10</a></h2>
6486
<p>WASI I/O is an I/O abstraction API which is currently focused on providing
6587
stream types.</p>
6688
<p>In the future, the component model is expected to add built-in stream types;
6789
when it does, they are expected to subsume this API.</p>
6890
<hr />
6991
<h3>Types</h3>
70-
<h4><a name="pollable"><code>type pollable</code></a></h4>
71-
<p><a href="#pollable"><a href="#pollable"><code>pollable</code></a></a></p>
92+
<h4><a name="error"><code>type error</code></a></h4>
93+
<p><a href="#error"><a href="#error"><code>error</code></a></a></p>
94+
<p>
95+
#### <a name="pollable">`type pollable`</a>
96+
[`pollable`](#pollable)
7297
<p>
73-
#### <a name="error">`resource error`</a>
74-
<h4><a name="stream_error"><code>variant stream-error</code></a></h4>
98+
#### <a name="stream_error">`variant stream-error`</a>
7599
<p>An error for input-stream and output-stream operations.</p>
76100
<h5>Variant Cases</h5>
77101
<ul>
@@ -91,20 +115,6 @@ future operations.
91115
<h4><a name="output_stream"><code>resource output-stream</code></a></h4>
92116
<hr />
93117
<h3>Functions</h3>
94-
<h4><a name="method_error.to_debug_string"><code>[method]error.to-debug-string: func</code></a></h4>
95-
<p>Returns a string that's suitable to assist humans in debugging this
96-
error.</p>
97-
<p>The returned string will change across platforms and hosts which
98-
means that parsing it, for example, would be a
99-
platform-compatibility hazard.</p>
100-
<h5>Params</h5>
101-
<ul>
102-
<li><a name="method_error.to_debug_string.self"><code>self</code></a>: borrow&lt;<a href="#error"><a href="#error"><code>error</code></a></a>&gt;</li>
103-
</ul>
104-
<h5>Return values</h5>
105-
<ul>
106-
<li><a name="method_error.to_debug_string.0"></a> <code>string</code></li>
107-
</ul>
108118
<h4><a name="method_input_stream.read"><code>[method]input-stream.read: func</code></a></h4>
109119
<p>Perform a non-blocking read from the stream.</p>
110120
<p>This function returns a list of bytes containing the read data,
@@ -375,7 +385,7 @@ is ready for reading, before performing the <code>splice</code>.</p>
375385
<ul>
376386
<li><a name="method_output_stream.blocking_splice.0"></a> result&lt;<code>u64</code>, <a href="#stream_error"><a href="#stream_error"><code>stream-error</code></a></a>&gt;</li>
377387
</ul>
378-
<h2><a name="wasi:clocks_wall_clock">Import interface wasi:clocks/wall-clock</a></h2>
388+
<h2><a name="wasi:clocks_wall_clock_0.2.0_rc_2023_11_10">Import interface wasi:clocks/wall-clock@0.2.0-rc-2023-11-10</a></h2>
379389
<p>WASI Wall Clock is a clock API intended to let users query the current
380390
time. The name &quot;wall&quot; makes an analogy to a &quot;clock on the wall&quot;, which
381391
is not necessarily monotonic as it may be reset.</p>
@@ -416,7 +426,7 @@ also known as <a href="https://en.wikipedia.org/wiki/Unix_time">Unix Time</a>.</
416426
<ul>
417427
<li><a name="resolution.0"></a> <a href="#datetime"><a href="#datetime"><code>datetime</code></a></a></li>
418428
</ul>
419-
<h2><a name="wasi:filesystem_types">Import interface wasi:filesystem/types</a></h2>
429+
<h2><a name="wasi:filesystem_types_0.2.0_rc_2023_11_10">Import interface wasi:filesystem/types@0.2.0-rc-2023-11-10</a></h2>
420430
<p>WASI filesystem is a filesystem API primarily intended to let users run WASI
421431
programs that access their files on their existing filesystems, without
422432
significant overhead.</p>
@@ -1293,7 +1303,7 @@ errors are filesystem-related errors.</p>
12931303
<ul>
12941304
<li><a name="filesystem_error_code.0"></a> option&lt;<a href="#error_code"><a href="#error_code"><code>error-code</code></a></a>&gt;</li>
12951305
</ul>
1296-
<h2><a name="wasi:filesystem_preopens">Import interface wasi:filesystem/preopens</a></h2>
1306+
<h2><a name="wasi:filesystem_preopens_0.2.0_rc_2023_11_10">Import interface wasi:filesystem/preopens@0.2.0-rc-2023-11-10</a></h2>
12971307
<hr />
12981308
<h3>Types</h3>
12991309
<h4><a name="descriptor"><code>type descriptor</code></a></h4>

0 commit comments

Comments
 (0)