-
Notifications
You must be signed in to change notification settings - Fork 19
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
1 parent
fe0ebbc
commit 930914d
Showing
14 changed files
with
171 additions
and
62 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
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,16 +2,16 @@ | |
<ul> | ||
<li>Imports: | ||
<ul> | ||
<li>interface <a href="#wasi_io_error_0_2_0"><code>wasi:io/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_io_poll_0_2_0"><code>wasi:io/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_io_streams_0_2_0"><code>wasi:io/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_clocks_wall_clock_0_2_0"><code>wasi:clocks/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_filesystem_types_0_2_0"><code>wasi:filesystem/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_filesystem_preopens_0_2_0"><code>wasi:filesystem/[email protected].0</code></a></li> | ||
<li>interface <a href="#wasi_io_error_0_2_1"><code>wasi:io/[email protected].1</code></a></li> | ||
<li>interface <a href="#wasi_io_poll_0_2_1"><code>wasi:io/[email protected].1</code></a></li> | ||
<li>interface <a href="#wasi_io_streams_0_2_1"><code>wasi:io/[email protected].1</code></a></li> | ||
<li>interface <a href="#wasi_clocks_wall_clock_0_2_1"><code>wasi:clocks/[email protected].1</code></a></li> | ||
<li>interface <a href="#wasi_filesystem_types_0_2_1"><code>wasi:filesystem/[email protected].1</code></a></li> | ||
<li>interface <a href="#wasi_filesystem_preopens_0_2_1"><code>wasi:filesystem/[email protected].1</code></a></li> | ||
</ul> | ||
</li> | ||
</ul> | ||
<h2><a name="wasi_io_error_0_2_0"></a>Import interface wasi:io/[email protected].0</h2> | ||
<h2><a name="wasi_io_error_0_2_1"></a>Import interface wasi:io/[email protected].1</h2> | ||
<hr /> | ||
<h3>Types</h3> | ||
<h4><a name="error"></a><code>resource error</code></h4> | ||
|
@@ -21,13 +21,11 @@ which provides some human-readable information about the error.</p> | |
<p>In the <code>wasi:io</code> package, this resource is returned through the | ||
<code>wasi:io/streams/stream-error</code> type.</p> | ||
<p>To provide more specific error information, other interfaces may | ||
provide functions to further "downcast" this error into more specific | ||
error information. For example, <a href="#error"><code>error</code></a>s returned in streams derived | ||
from filesystem types to be described using the filesystem's own | ||
error-code type, using the function | ||
<code>wasi:filesystem/types/filesystem-error-code</code>, which takes a parameter | ||
<code>borrow<error></code> and returns | ||
<code>option<wasi:filesystem/types/error-code></code>.</p> | ||
offer functions to "downcast" this error into more specific types. For example, | ||
errors returned from streams derived from filesystem types can be described using | ||
the filesystem's own error-code type. This is done using the function | ||
<code>wasi:filesystem/types/filesystem-error-code</code>, which takes a <code>borrow<error></code> | ||
parameter and returns an <code>option<wasi:filesystem/types/error-code></code>.</p> | ||
<h2>The set of functions which can "downcast" an <a href="#error"><code>error</code></a> into a more | ||
concrete type is open.</h2> | ||
<h3>Functions</h3> | ||
|
@@ -46,7 +44,7 @@ hazard.</p> | |
<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"></a>Import interface wasi:io/[email protected].0</h2> | ||
<h2><a name="wasi_io_poll_0_2_1"></a>Import interface wasi:io/[email protected].1</h2> | ||
<p>A poll API intended to let users wait for I/O events on multiple handles | ||
at once.</p> | ||
<hr /> | ||
|
@@ -80,14 +78,17 @@ containing only this pollable.</p> | |
interest, and waits until one or more of the events is ready for I/O.</p> | ||
<p>The result <code>list<u32></code> contains one or more indices of handles in the | ||
argument list that is ready for I/O.</p> | ||
<p>If the list contains more elements than can be indexed with a <code>u32</code> | ||
value, this function traps.</p> | ||
<p>This function traps if either:</p> | ||
<ul> | ||
<li>the list is empty, or:</li> | ||
<li>the list contains more elements than can be indexed with a <code>u32</code> value.</li> | ||
</ul> | ||
<p>A timeout can be implemented by adding a pollable from the | ||
wasi-clocks API to the list.</p> | ||
<p>This function does not return a <code>result</code>; polling in itself does not | ||
do any I/O so it doesn't fail. If any of the I/O sources identified by | ||
the pollables has an error, it is indicated by marking the source as | ||
being reaedy for I/O.</p> | ||
being ready for I/O.</p> | ||
<h5>Params</h5> | ||
<ul> | ||
<li><a name="poll.in"></a><code>in</code>: list<borrow<<a href="#pollable"><a href="#pollable"><code>pollable</code></a></a>>></li> | ||
|
@@ -96,7 +97,7 @@ 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_0_2_0"></a>Import interface wasi:io/[email protected].0</h2> | ||
<h2><a name="wasi_io_streams_0_2_1"></a>Import interface wasi:io/[email protected].1</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; | ||
|
@@ -135,12 +136,15 @@ use the <code>subscribe</code> function to obtain a <a href="#pollable"><code>po | |
for using <code>wasi:io/poll</code>.</p> | ||
<h4><a name="output_stream"></a><code>resource output-stream</code></h4> | ||
<p>An output bytestream.</p> | ||
<h2><a href="#output_stream"><code>output-stream</code></a>s are <em>non-blocking</em> to the extent practical on | ||
<p><a href="#output_stream"><code>output-stream</code></a>s are <em>non-blocking</em> to the extent practical on | ||
underlying platforms. Except where specified otherwise, I/O operations also | ||
always return promptly, after the number of bytes that can be written | ||
promptly, which could even be zero. To wait for the stream to be ready to | ||
accept data, the <code>subscribe</code> function to obtain a <a href="#pollable"><code>pollable</code></a> which can be | ||
polled for using <code>wasi:io/poll</code>.</h2> | ||
polled for using <code>wasi:io/poll</code>.</p> | ||
<h2>Dropping an <a href="#output_stream"><code>output-stream</code></a> while there's still an active write in | ||
progress may result in the data being lost. Before dropping the stream, | ||
be sure to fully flush your writes.</h2> | ||
<h3>Functions</h3> | ||
<h4><a name="method_input_stream_read"></a><code>[method]input-stream.read: func</code></h4> | ||
<p>Perform a non-blocking read from the stream.</p> | ||
|
@@ -322,7 +326,7 @@ and stream is ready for writing again.</p> | |
</ul> | ||
<h4><a name="method_output_stream_subscribe"></a><code>[method]output-stream.subscribe: func</code></h4> | ||
<p>Create a <a href="#pollable"><code>pollable</code></a> which will resolve once the output-stream | ||
is ready for more writing, or an error has occured. When this | ||
is ready for more writing, or an error has occurred. When this | ||
pollable is ready, <code>check-write</code> will return <code>ok(n)</code> with n>0, or an | ||
error.</p> | ||
<p>If the stream is closed, this pollable is always ready immediately.</p> | ||
|
@@ -385,7 +389,7 @@ let _ = this.check-write(); // eliding error handling | |
</ul> | ||
<h4><a name="method_output_stream_splice"></a><code>[method]output-stream.splice: func</code></h4> | ||
<p>Read from one stream and write to another.</p> | ||
<p>The behavior of splice is equivelant to:</p> | ||
<p>The behavior of splice is equivalent to:</p> | ||
<ol> | ||
<li>calling <code>check-write</code> on the <a href="#output_stream"><code>output-stream</code></a></li> | ||
<li>calling <code>read</code> on the <a href="#input_stream"><code>input-stream</code></a> with the smaller of the | ||
|
@@ -421,7 +425,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_0_2_0"></a>Import interface wasi:clocks/[email protected].0</h2> | ||
<h2><a name="wasi_clocks_wall_clock_0_2_1"></a>Import interface wasi:clocks/[email protected].1</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> | ||
|
@@ -462,7 +466,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_0_2_0"></a>Import interface wasi:filesystem/[email protected].0</h2> | ||
<h2><a name="wasi_filesystem_types_0_2_1"></a>Import interface wasi:filesystem/[email protected].1</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> | ||
|
@@ -1342,7 +1346,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_0_2_0"></a>Import interface wasi:filesystem/[email protected].0</h2> | ||
<h2><a name="wasi_filesystem_preopens_0_2_1"></a>Import interface wasi:filesystem/[email protected].1</h2> | ||
<hr /> | ||
<h3>Types</h3> | ||
<h4><a name="descriptor"></a><code>type descriptor</code></h4> | ||
|
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 |
---|---|---|
@@ -1,9 +1,9 @@ | ||
[clocks] | ||
url = "https://github.com/WebAssembly/wasi-clocks/archive/main.tar.gz" | ||
sha256 = "468b4d12892fe926b8eb5d398dbf579d566c93231fa44f415440572c695b7613" | ||
sha512 = "e6b53a07221f1413953c9797c68f08b815fdaebf66419bbc1ea3e8b7dece73731062693634731f311a03957b268cf9cc509c518bd15e513c318aa04a8459b93a" | ||
sha256 = "ea9d69ee803bc176e23e5268f5e24a2ac485dd1f62a0ab4c748e9d3f901f576f" | ||
sha512 = "5efc22927c46cd56c41e5549ec775561c7fac2ea0d365abc0b55396d9475a7c9f984077a81f84a44a726f1c008fd2fadbffffa4fa53ecd5fbfd05afd379ab428" | ||
|
||
[io] | ||
url = "https://github.com/WebAssembly/wasi-io/archive/main.tar.gz" | ||
sha256 = "7210e5653539a15478f894d4da24cc69d61924cbcba21d2804d69314a88e5a4c" | ||
sha512 = "49184a1b0945a889abd52d25271172ed3dc2db6968fcdddb1bab7ee0081f4a3eeee0977ad2291126a37631c0d86eeea75d822fa8af224c422134500bf9f0f2bb" | ||
sha256 = "2a74bd811adc46b5a0f19827ddbde89870e52b17615f4d0873f06fd977250caf" | ||
sha512 = "94624f00c66e66203592cee820f80b1ba91ecdb71f682c154f25eaf71f8d8954197dcb64503bc21e72ed5e812af7eae876df47b7eb727b02db3a74a7ce0aefca" |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
package wasi:clocks@0.2.0; | ||
package wasi:clocks@0.2.1; | ||
/// WASI Monotonic Clock is a clock API intended to let users measure elapsed | ||
/// time. | ||
/// | ||
|
@@ -7,38 +7,43 @@ package wasi:[email protected]; | |
/// | ||
/// A monotonic clock is a clock which has an unspecified initial value, and | ||
/// successive reads of the clock will produce non-decreasing values. | ||
/// | ||
/// It is intended for measuring elapsed time. | ||
@since(version = 0.2.0) | ||
interface monotonic-clock { | ||
use wasi:io/poll@0.2.0.{pollable}; | ||
@since(version = 0.2.0) | ||
use wasi:io/poll@0.2.1.{pollable}; | ||
|
||
/// An instant in time, in nanoseconds. An instant is relative to an | ||
/// unspecified initial value, and can only be compared to instances from | ||
/// the same monotonic-clock. | ||
@since(version = 0.2.0) | ||
type instant = u64; | ||
|
||
/// A duration of time, in nanoseconds. | ||
@since(version = 0.2.0) | ||
type duration = u64; | ||
|
||
/// Read the current value of the clock. | ||
/// | ||
/// The clock is monotonic, therefore calling this function repeatedly will | ||
/// produce a sequence of non-decreasing values. | ||
@since(version = 0.2.0) | ||
now: func() -> instant; | ||
|
||
/// Query the resolution of the clock. Returns the duration of time | ||
/// corresponding to a clock tick. | ||
@since(version = 0.2.0) | ||
resolution: func() -> duration; | ||
|
||
/// Create a `pollable` which will resolve once the specified instant | ||
/// occured. | ||
/// has occurred. | ||
@since(version = 0.2.0) | ||
subscribe-instant: func( | ||
when: instant, | ||
) -> pollable; | ||
|
||
/// Create a `pollable` which will resolve once the given duration has | ||
/// elapsed, starting at the time at which this function was called. | ||
/// occured. | ||
/// Create a `pollable` that will resolve after the specified duration has | ||
/// elapsed from the time this function is invoked. | ||
@since(version = 0.2.0) | ||
subscribe-duration: func( | ||
when: duration, | ||
) -> pollable; | ||
|
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 |
---|---|---|
@@ -0,0 +1,55 @@ | ||
package wasi:clocks@0.2.1; | ||
|
||
@unstable(feature = clocks-timezone) | ||
interface timezone { | ||
@unstable(feature = clocks-timezone) | ||
use wall-clock.{datetime}; | ||
|
||
/// Return information needed to display the given `datetime`. This includes | ||
/// the UTC offset, the time zone name, and a flag indicating whether | ||
/// daylight saving time is active. | ||
/// | ||
/// If the timezone cannot be determined for the given `datetime`, return a | ||
/// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight | ||
/// saving time. | ||
@unstable(feature = clocks-timezone) | ||
display: func(when: datetime) -> timezone-display; | ||
|
||
/// The same as `display`, but only return the UTC offset. | ||
@unstable(feature = clocks-timezone) | ||
utc-offset: func(when: datetime) -> s32; | ||
|
||
/// Information useful for displaying the timezone of a specific `datetime`. | ||
/// | ||
/// This information may vary within a single `timezone` to reflect daylight | ||
/// saving time adjustments. | ||
@unstable(feature = clocks-timezone) | ||
record timezone-display { | ||
/// The number of seconds difference between UTC time and the local | ||
/// time of the timezone. | ||
/// | ||
/// The returned value will always be less than 86400 which is the | ||
/// number of seconds in a day (24*60*60). | ||
/// | ||
/// In implementations that do not expose an actual time zone, this | ||
/// should return 0. | ||
utc-offset: s32, | ||
|
||
/// The abbreviated name of the timezone to display to a user. The name | ||
/// `UTC` indicates Coordinated Universal Time. Otherwise, this should | ||
/// reference local standards for the name of the time zone. | ||
/// | ||
/// In implementations that do not expose an actual time zone, this | ||
/// should be the string `UTC`. | ||
/// | ||
/// In time zones that do not have an applicable name, a formatted | ||
/// representation of the UTC offset may be returned, such as `-04:00`. | ||
name: string, | ||
|
||
/// Whether daylight saving time is active. | ||
/// | ||
/// In implementations that do not expose an actual time zone, this | ||
/// should return false. | ||
in-daylight-saving-time: bool, | ||
} | ||
} |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
package wasi:clocks@0.2.0; | ||
package wasi:clocks@0.2.1; | ||
/// 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. | ||
|
@@ -13,8 +13,10 @@ package wasi:[email protected]; | |
/// monotonic, making it unsuitable for measuring elapsed time. | ||
/// | ||
/// It is intended for reporting the current date and time for humans. | ||
@since(version = 0.2.0) | ||
interface wall-clock { | ||
/// A time and date in seconds plus nanoseconds. | ||
@since(version = 0.2.0) | ||
record datetime { | ||
seconds: u64, | ||
nanoseconds: u32, | ||
|
@@ -33,10 +35,12 @@ interface wall-clock { | |
/// | ||
/// [POSIX's Seconds Since the Epoch]: https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xbd_chap04.html#tag_21_04_16 | ||
/// [Unix Time]: https://en.wikipedia.org/wiki/Unix_time | ||
@since(version = 0.2.0) | ||
now: func() -> datetime; | ||
|
||
/// Query the resolution of the clock. | ||
/// | ||
/// The nanoseconds field of the output is always less than 1000000000. | ||
@since(version = 0.2.0) | ||
resolution: func() -> datetime; | ||
} |
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 |
---|---|---|
@@ -1,6 +1,11 @@ | ||
package wasi:clocks@0.2.0; | ||
package wasi:clocks@0.2.1; | ||
|
||
@since(version = 0.2.0) | ||
world imports { | ||
@since(version = 0.2.0) | ||
import monotonic-clock; | ||
@since(version = 0.2.0) | ||
import wall-clock; | ||
@unstable(feature = clocks-timezone) | ||
import timezone; | ||
} |
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
Oops, something went wrong.