-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Pat Hickey
committed
Nov 10, 2023
1 parent
76eb886
commit 3180d00
Showing
1 changed file
with
38 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,15 +2,37 @@ | |
| <ul> | ||
| <li>Imports: | ||
| <ul> | ||
| <li>interface <a href="#wasi:io_poll"><code>wasi:io/poll</code></a></li> | ||
| <li>interface <a href="#wasi:io_streams"><code>wasi:io/streams</code></a></li> | ||
| <li>interface <a href="#wasi:clocks_wall_clock"><code>wasi:clocks/wall-clock</code></a></li> | ||
| <li>interface <a href="#wasi:filesystem_types"><code>wasi:filesystem/types</code></a></li> | ||
| <li>interface <a href="#wasi:filesystem_preopens"><code>wasi:filesystem/preopens</code></a></li> | ||
| <li>interface <a href="#wasi:io_error_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li> | ||
| <li>interface <a href="#wasi:io_poll_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li> | ||
| <li>interface <a href="#wasi:io_streams_0.2.0_rc_2023_11_10"><code>wasi:io/[email protected]</code></a></li> | ||
| <li>interface <a href="#wasi:clocks_wall_clock_0.2.0_rc_2023_11_10"><code>wasi:clocks/[email protected]</code></a></li> | ||
| <li>interface <a href="#wasi:filesystem_types_0.2.0_rc_2023_11_10"><code>wasi:filesystem/[email protected]</code></a></li> | ||
| <li>interface <a href="#wasi:filesystem_preopens_0.2.0_rc_2023_11_10"><code>wasi:filesystem/[email protected]</code></a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <h2><a name="wasi:io_poll">Import interface wasi:io/poll</a></h2> | ||
| <h2><a name="wasi:io_error_0.2.0_rc_2023_11_10">Import interface wasi:io/[email protected]</a></h2> | ||
| <hr /> | ||
| <h3>Types</h3> | ||
| <h4><a name="error"><code>resource error</code></a></h4> | ||
| <hr /> | ||
| <h3>Functions</h3> | ||
| <h4><a name="method_error.to_debug_string"><code>[method]error.to-debug-string: func</code></a></h4> | ||
| <p>Returns a string that is suitable to assist humans in debugging | ||
| this error.</p> | ||
| <p>WARNING: The returned string should not be consumed mechanically! | ||
| It may change across platforms, hosts, or other implementation | ||
| details. Parsing this string is a major platform-compatibility | ||
| hazard.</p> | ||
| <h5>Params</h5> | ||
| <ul> | ||
| <li><a name="method_error.to_debug_string.self"><code>self</code></a>: borrow<<a href="#error"><a href="#error"><code>error</code></a></a>></li> | ||
| </ul> | ||
| <h5>Return values</h5> | ||
| <ul> | ||
| <li><a name="method_error.to_debug_string.0"></a> <code>string</code></li> | ||
| </ul> | ||
| <h2><a name="wasi:io_poll_0.2.0_rc_2023_11_10">Import interface wasi:io/[email protected]</a></h2> | ||
| <p>A poll API intended to let users wait for I/O events on multiple handles | ||
| at once.</p> | ||
| <hr /> | ||
|
|
@@ -60,18 +82,20 @@ being reaedy for I/O.</p> | |
| <ul> | ||
| <li><a name="poll.0"></a> list<<code>u32</code>></li> | ||
| </ul> | ||
| <h2><a name="wasi:io_streams">Import interface wasi:io/streams</a></h2> | ||
| <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> | ||
| <p>WASI I/O is an I/O abstraction API which is currently focused on providing | ||
| stream types.</p> | ||
| <p>In the future, the component model is expected to add built-in stream types; | ||
| when it does, they are expected to subsume this API.</p> | ||
| <hr /> | ||
| <h3>Types</h3> | ||
| <h4><a name="pollable"><code>type pollable</code></a></h4> | ||
| <p><a href="#pollable"><a href="#pollable"><code>pollable</code></a></a></p> | ||
| <h4><a name="error"><code>type error</code></a></h4> | ||
| <p><a href="#error"><a href="#error"><code>error</code></a></a></p> | ||
| <p> | ||
| #### <a name="pollable">`type pollable`</a> | ||
| [`pollable`](#pollable) | ||
| <p> | ||
| #### <a name="error">`resource error`</a> | ||
| <h4><a name="stream_error"><code>variant stream-error</code></a></h4> | ||
| #### <a name="stream_error">`variant stream-error`</a> | ||
| <p>An error for input-stream and output-stream operations.</p> | ||
| <h5>Variant Cases</h5> | ||
| <ul> | ||
|
|
@@ -91,20 +115,6 @@ future operations. | |
| <h4><a name="output_stream"><code>resource output-stream</code></a></h4> | ||
| <hr /> | ||
| <h3>Functions</h3> | ||
| <h4><a name="method_error.to_debug_string"><code>[method]error.to-debug-string: func</code></a></h4> | ||
| <p>Returns a string that's suitable to assist humans in debugging this | ||
| error.</p> | ||
| <p>The returned string will change across platforms and hosts which | ||
| means that parsing it, for example, would be a | ||
| platform-compatibility hazard.</p> | ||
| <h5>Params</h5> | ||
| <ul> | ||
| <li><a name="method_error.to_debug_string.self"><code>self</code></a>: borrow<<a href="#error"><a href="#error"><code>error</code></a></a>></li> | ||
| </ul> | ||
| <h5>Return values</h5> | ||
| <ul> | ||
| <li><a name="method_error.to_debug_string.0"></a> <code>string</code></li> | ||
| </ul> | ||
| <h4><a name="method_input_stream.read"><code>[method]input-stream.read: func</code></a></h4> | ||
| <p>Perform a non-blocking read from the stream.</p> | ||
| <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> | |
| <ul> | ||
| <li><a name="method_output_stream.blocking_splice.0"></a> result<<code>u64</code>, <a href="#stream_error"><a href="#stream_error"><code>stream-error</code></a></a>></li> | ||
| </ul> | ||
| <h2><a name="wasi:clocks_wall_clock">Import interface wasi:clocks/wall-clock</a></h2> | ||
| <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> | ||
| <p>WASI Wall Clock is a clock API intended to let users query the current | ||
| time. The name "wall" makes an analogy to a "clock on the wall", which | ||
| 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>.</ | |
| <ul> | ||
| <li><a name="resolution.0"></a> <a href="#datetime"><a href="#datetime"><code>datetime</code></a></a></li> | ||
| </ul> | ||
| <h2><a name="wasi:filesystem_types">Import interface wasi:filesystem/types</a></h2> | ||
| <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> | ||
| <p>WASI filesystem is a filesystem API primarily intended to let users run WASI | ||
| programs that access their files on their existing filesystems, without | ||
| significant overhead.</p> | ||
|
|
@@ -1293,7 +1303,7 @@ errors are filesystem-related errors.</p> | |
| <ul> | ||
| <li><a name="filesystem_error_code.0"></a> option<<a href="#error_code"><a href="#error_code"><code>error-code</code></a></a>></li> | ||
| </ul> | ||
| <h2><a name="wasi:filesystem_preopens">Import interface wasi:filesystem/preopens</a></h2> | ||
| <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> | ||
| <hr /> | ||
| <h3>Types</h3> | ||
| <h4><a name="descriptor"><code>type descriptor</code></a></h4> | ||
|
|
||