wasi:cli/environment@0.2.0wasi:cli/exit@0.2.0wasi:io/error@0.2.0wasi:io/poll@0.2.0wasi:io/streams@0.2.0wasi:cli/stdin@0.2.0wasi:cli/stdout@0.2.0wasi:cli/stderr@0.2.0wasi:cli/terminal-input@0.2.0wasi:cli/terminal-output@0.2.0wasi:cli/terminal-stdin@0.2.0wasi:cli/terminal-stdout@0.2.0wasi:cli/terminal-stderr@0.2.0wasi:clocks/monotonic-clock@0.2.0wasi:clocks/wall-clock@0.2.0wasi:filesystem/types@0.2.0wasi:filesystem/preopens@0.2.0wasi:sockets/network@0.2.0wasi:sockets/instance-network@0.2.0wasi:sockets/udp@0.2.0wasi:sockets/udp-create-socket@0.2.0wasi:sockets/tcp@0.2.0wasi:sockets/tcp-create-socket@0.2.0wasi:sockets/ip-name-lookup@0.2.0wasi:random/random@0.2.0wasi:random/insecure@0.2.0wasi:random/insecure-seed@0.2.0wasi:cli/environment@0.2.0wasi:cli/exit@0.2.0wasi:io/error@0.2.0wasi:io/poll@0.2.0wasi:io/streams@0.2.0wasi:cli/stdin@0.2.0wasi:cli/stdout@0.2.0wasi:cli/stderr@0.2.0wasi:cli/terminal-input@0.2.0wasi:cli/terminal-output@0.2.0wasi:cli/terminal-stdin@0.2.0wasi:cli/terminal-stdout@0.2.0wasi:cli/terminal-stderr@0.2.0wasi:clocks/monotonic-clock@0.2.0wasi:clocks/wall-clock@0.2.0wasi:filesystem/types@0.2.0wasi:filesystem/preopens@0.2.0wasi:sockets/network@0.2.0wasi:sockets/instance-network@0.2.0wasi:sockets/udp@0.2.0wasi:sockets/udp-create-socket@0.2.0wasi:sockets/tcp@0.2.0wasi:sockets/tcp-create-socket@0.2.0wasi:sockets/ip-name-lookup@0.2.0wasi:random/random@0.2.0wasi:random/insecure@0.2.0wasi:random/insecure-seed@0.2.0wasi:cli/run@0.2.0wasi:cli/run@0.2.0get-environment: funcget-environment: funcGet the POSIX-style environment variables.
Each environment variable is provided as a pair of string variable names and string value.
@@ -51,49 +51,47 @@ values each time it is called. -get-arguments: funcget-arguments: funcGet the POSIX-style arguments to the program.
initial-cwd: funcinitial-cwd: funcReturn a path that programs should use as their initial current working
directory, interpreting . as shorthand for this.
exit: funcexit: funcExit the current instance and any linked instances.
status: resultstatus: resultresource errorresource errorA resource which represents some error information.
The only method provided by this resource is to-debug-string,
which provides some human-readable information about the error.
In the wasi:io package, this resource is returned through the
wasi:io/streams/stream-error type.
To provide more specific error information, other interfaces may
-provide functions to further "downcast" this error into more specific
-error information. For example, errors returned in streams derived
-from filesystem types to be described using the filesystem's own
-error-code type, using the function
-wasi:filesystem/types/filesystem-error-code, which takes a parameter
-borrow<error> and returns
-option<wasi:filesystem/types/error-code>.
wasi:filesystem/types/filesystem-error-code, which takes a borrow<error>
+parameter and returns an option<wasi:filesystem/types/error-code>.
error into a more
concrete type is open.[method]error.to-debug-string: func[method]error.to-debug-string: funcReturns a string that is suitable to assist humans in debugging this error.
WARNING: The returned string should not be consumed mechanically! @@ -102,92 +100,95 @@ details. Parsing this string is a major platform-compatibility hazard.
A poll API intended to let users wait for I/O events on multiple handles at once.
resource pollableresource pollablepollable represents a single I/O event which may be ready, or not.[method]pollable.ready: func[method]pollable.ready: funcReturn the readiness of a pollable. This function never blocks.
Returns true when the pollable is ready, and false otherwise.
[method]pollable.block: func[method]pollable.block: funcblock returns immediately if the pollable is ready, and otherwise
blocks until ready.
This function is equivalent to calling poll.poll on a list
containing only this pollable.
poll: funcpoll: funcPoll for completion on a set of pollables.
This function takes a list of pollables, which identify I/O sources of interest, and waits until one or more of the events is ready for I/O.
The result list<u32> contains one or more indices of handles in the
argument list that is ready for I/O.
If the list contains more elements than can be indexed with a u32
-value, this function traps.
This function traps if either:
+u32 value.A timeout can be implemented by adding a pollable from the wasi-clocks API to the list.
This function does not return a result; 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.
WASI I/O is an I/O abstraction API which is currently focused on providing stream types.
In the future, the component model is expected to add built-in stream types; when it does, they are expected to subsume this API.
type errortype error-#### `type pollable` +#### `type pollable` [`pollable`](#pollable)
-#### `variant stream-error` +#### `variant stream-error`
An error for input-stream and output-stream operations.
last-operation-failed: own<error>
last-operation-failed: own<error>
The last operation (a write or flush) failed before completion.
More information is available in the error payload.
The stream is closed: no more input will be accepted by the stream. A closed output-stream will return this error on all future operations.
resource input-streamresource input-streamAn input bytestream.
input-streams are non-blocking to the extent practical on underlying
platforms. I/O operations always return promptly; if fewer bytes are
@@ -195,7 +196,7 @@ promptly available than requested, they return the number of bytes promptly
available, which could even be zero. To wait for data to be available,
use the subscribe function to obtain a pollable which can be polled
for using wasi:io/poll.
resource output-streamresource output-streamAn output bytestream.
output-streams are non-blocking to the extent practical on
underlying platforms. Except where specified otherwise, I/O operations also
@@ -204,7 +205,7 @@ promptly, which could even be zero. To wait for the stream to be ready to
accept data, the subscribe function to obtain a pollable which can be
polled for using wasi:io/poll.[method]input-stream.read: func[method]input-stream.read: funcPerform a non-blocking read from the stream.
When the source of a read is binary data, the bytes from the source
are returned verbatim. When the source of a read is known to the
@@ -228,51 +229,51 @@ as a return value by the callee. The callee may return a list of bytes
less than len in size while more bytes are available for reading.
self: borrow<input-stream>len: u64self: borrow<input-stream>len: u64u8>, stream-error>u8>, stream-error>[method]input-stream.blocking-read: func[method]input-stream.blocking-read: funcRead bytes from a stream, after blocking until at least one byte can
be read. Except for blocking, behavior is identical to read.
self: borrow<input-stream>len: u64self: borrow<input-stream>len: u64u8>, stream-error>u8>, stream-error>[method]input-stream.skip: func[method]input-stream.skip: funcSkip bytes from a stream. Returns number of bytes skipped.
Behaves identical to read, except instead of returning a list
of bytes, returns the number of bytes consumed from the stream.
self: borrow<input-stream>len: u64self: borrow<input-stream>len: u64u64, stream-error>u64, stream-error>[method]input-stream.blocking-skip: func[method]input-stream.blocking-skip: funcSkip bytes from a stream, after blocking until at least one byte
can be skipped. Except for blocking behavior, identical to skip.
self: borrow<input-stream>len: u64self: borrow<input-stream>len: u64u64, stream-error>u64, stream-error>[method]input-stream.subscribe: func[method]input-stream.subscribe: funcCreate a pollable which will resolve once either the specified stream
has bytes available to read or the other end of the stream has been
closed.
@@ -281,13 +282,13 @@ Implementations may trap if the input-streampollables created with this function are dropped.
self: borrow<input-stream>self: borrow<input-stream>[method]output-stream.check-write: func[method]output-stream.check-write: funcCheck readiness for writing. This function never blocks.
Returns the number of bytes permitted for the next call to write,
or an error. Calling write with more bytes than this function has
@@ -297,13 +298,13 @@ become ready when this function will report at least 1 byte, or an
error.
self: borrow<output-stream>self: borrow<output-stream>u64, stream-error>u64, stream-error>[method]output-stream.write: func[method]output-stream.write: funcPerform a write. This function never blocks.
When the destination of a write is binary data, the bytes from
contents are written verbatim. When the destination of a write is
@@ -316,14 +317,14 @@ length of less than or equal to n. Otherwise, this function will trap.
self: borrow<output-stream>contents: list<u8>self: borrow<output-stream>contents: list<u8>stream-error>stream-error>[method]output-stream.blocking-write-and-flush: func[method]output-stream.blocking-write-and-flush: funcPerform a write of up to 4096 bytes, and then flush the stream. Block until all of these operations are complete, or an error occurs.
This is a convenience wrapper around the use of check-write,
@@ -347,14 +348,14 @@ let _ = this.check-write(); // eliding error handling
self: borrow<output-stream>contents: list<u8>self: borrow<output-stream>contents: list<u8>stream-error>stream-error>[method]output-stream.flush: func[method]output-stream.flush: funcRequest to flush buffered output. This function never blocks.
This tells the output-stream that the caller intends any buffered
output to be flushed. the output which is expected to be flushed
@@ -365,24 +366,24 @@ completed. The subscribe pollable will become ready when the
flush has completed and the stream can accept more writes.
self: borrow<output-stream>self: borrow<output-stream>stream-error>stream-error>[method]output-stream.blocking-flush: func[method]output-stream.blocking-flush: funcRequest to flush buffered output, and block until flush completes and stream is ready for writing again.
self: borrow<output-stream>self: borrow<output-stream>stream-error>stream-error>[method]output-stream.subscribe: func[method]output-stream.subscribe: funcCreate a pollable which will resolve once the output-stream
is ready for more writing, or an error has occured. When this
pollable is ready, check-write will return ok(n) with n>0, or an
@@ -393,13 +394,13 @@ Implementations may trap if the output-streams created with this function are dropped.pollable
self: borrow<output-stream>self: borrow<output-stream>[method]output-stream.write-zeroes: func[method]output-stream.write-zeroes: funcWrite zeroes to a stream.
This should be used precisely like write with the exact same
preconditions (must use check-write first), but instead of
@@ -407,14 +408,14 @@ passing a list of bytes, you simply pass the number of zero-bytes
that should be written.
self: borrow<output-stream>len: u64self: borrow<output-stream>len: u64stream-error>stream-error>[method]output-stream.blocking-write-zeroes-and-flush: func[method]output-stream.blocking-write-zeroes-and-flush: funcPerform a write of up to 4096 zeroes, and then flush the stream. Block until all of these operations are complete, or an error occurs.
@@ -438,14 +439,14 @@ let _ = this.check-write(); // eliding error handlingself: borrow<output-stream>len: u64self: borrow<output-stream>len: u64stream-error>stream-error>[method]output-stream.splice: func[method]output-stream.splice: funcRead from one stream and write to another.
The behavior of splice is equivelant to:
len.
self: borrow<output-stream>src: borrow<input-stream>len: u64self: borrow<output-stream>src: borrow<input-stream>len: u64u64, stream-error>u64, stream-error>[method]output-stream.blocking-splice: func[method]output-stream.blocking-splice: funcRead from one stream and write to another, with blocking.
This is similar to splice, except that it blocks until the
output-stream is ready for writing, and the input-stream
is ready for reading, before performing the splice.
self: borrow<output-stream>src: borrow<input-stream>len: u64self: borrow<output-stream>src: borrow<input-stream>len: u64u64, stream-error>u64, stream-error>type input-streamtype input-stream----
get-stdin: funcget-stdin: funcinput-stream>type output-streamtype output-stream----
get-stdout: funcget-stdout: funcoutput-stream>type output-streamtype output-stream----
get-stderr: funcget-stderr: funcoutput-stream>Terminal input.
In the future, this may include functions for disabling echoing, disabling input buffering so that keyboard events are sent through immediately, querying supported features, and so on.
resource terminal-inputresource terminal-inputThe input side of a terminal.
-Terminal output.
In the future, this may include functions for querying the terminal size, being notified of terminal size changes, querying supported features, and so on.
resource terminal-outputresource terminal-outputThe output side of a terminal.
-An interface providing an optional terminal-input for stdin as a
link-time authority.
type terminal-inputtype terminal-input----
get-terminal-stdin: funcget-terminal-stdin: funcIf stdin is connected to a terminal, return a terminal-input handle
allowing further interaction with it.
terminal-input>>An interface providing an optional terminal-output for stdout as a
link-time authority.
type terminal-outputtype terminal-output----
get-terminal-stdout: funcget-terminal-stdout: funcIf stdout is connected to a terminal, return a terminal-output handle
allowing further interaction with it.
terminal-output>>An interface providing an optional terminal-output for stderr as a
link-time authority.
type terminal-outputtype terminal-output----
get-terminal-stderr: funcget-terminal-stderr: funcIf stderr is connected to a terminal, return a terminal-output handle
allowing further interaction with it.
terminal-output>>WASI Monotonic Clock is a clock API intended to let users measure elapsed time.
It is intended to be portable at least between Unix-family platforms and Windows.
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.
type pollabletype pollable-#### `type instant` +#### `type instant` `u64`
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. -
type durationtype durationu64
A duration of time, in nanoseconds.
now: funcnow: funcRead the current value of the clock.
The clock is monotonic, therefore calling this function repeatedly will produce a sequence of non-decreasing values.
@@ -622,37 +622,36 @@ produce a sequence of non-decreasing values. -resolution: funcresolution: funcQuery the resolution of the clock. Returns the duration of time corresponding to a clock tick.
subscribe-instant: funcsubscribe-instant: funcCreate a pollable which will resolve once the specified instant
-occured.
pollable>subscribe-duration: funcCreate a pollable which will resolve once the given duration has
-elapsed, starting at the time at which this function was called.
-occured.
subscribe-duration: funcCreate a pollable that will resolve after the specified duration has
+elapsed from the time this function is invoked.
pollable>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.
@@ -665,16 +664,16 @@ monotonic, making it unsuitable for measuring elapsed time.It is intended for reporting the current date and time for humans.
record datetimerecord datetimeA time and date in seconds plus nanoseconds.
seconds: u64nanoseconds: u32seconds: u64nanoseconds: u32now: funcnow: funcRead the current value of the clock.
This clock is not monotonic, therefore calling this function repeatedly will not necessarily produce a sequence of non-decreasing values.
@@ -686,14 +685,14 @@ also known as Unix Time.datetimeresolution: funcresolution: funcQuery the resolution of the clock.
The nanoseconds field of the output is always less than 1000000000.
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.
@@ -713,75 +712,75 @@ underlying filesystem, the function fails with WASI filesystem path resolution.type input-streamtype input-stream-#### `type output-stream` +#### `type output-stream` [`output-stream`](#output_stream)
-#### `type error` +#### `type error` [`error`](#error)
-#### `type datetime` +#### `type datetime` [`datetime`](#datetime)
-#### `type filesize` +#### `type filesize` `u64`
File size or length of a region within a file. -
enum descriptor-typeenum descriptor-typeThe type of a filesystem object referenced by a descriptor.
Note: This was called filetype in earlier versions of WASI.
The type of the descriptor or file is unknown or is different from any of the other types specified.
The descriptor refers to a block device inode.
The descriptor refers to a character device inode.
The descriptor refers to a directory inode.
The descriptor refers to a named pipe.
The file refers to a symbolic link inode.
The descriptor refers to a regular file inode.
The descriptor refers to a socket.
flags descriptor-flagsflags descriptor-flagsDescriptor flags.
Note: This was called fdflags in earlier versions of WASI.
read:
Read mode: Data can be read.
Write mode: Data can be written to.
Request that writes be performed according to synchronized I/O file integrity completion. The data stored in the file and the file's metadata are synchronized. This is similar to `O_SYNC` in POSIX. @@ -790,7 +789,7 @@ WASI. At this time, it should be interpreted as a request, and not a requirement.
Request that writes be performed according to synchronized I/O data integrity completion. Only the data stored in the file is synchronized. This is similar to `O_DSYNC` in POSIX. @@ -799,7 +798,7 @@ WASI. At this time, it should be interpreted as a request, and not a requirement.
Requests that reads be performed at the same level of integrety requested for writes. This is similar to `O_RSYNC` in POSIX.
The precise semantics of this operation have not yet been defined for @@ -807,7 +806,7 @@ WASI. At this time, it should be interpreted as a request, and not a requirement.
Mutating directories mode: Directory contents may be mutated.
When this flag is unset on a descriptor, operations using the descriptor which would create, rename, delete, modify the data or @@ -817,107 +816,107 @@ they would otherwise succeed.
This may only be set on directories.
flags path-flagsflags path-flagsFlags determining the method of how paths are resolved.
symlink-follow: As long as the resolved path corresponds to a symbolic link, it is +
symlink-follow: As long as the resolved path corresponds to a symbolic link, it is expanded.
flags open-flagsflags open-flagsOpen flags used by open-at.
Create file if it does not exist, similar to `O_CREAT` in POSIX.
Fail if not a directory, similar to `O_DIRECTORY` in POSIX.
Fail if file already exists, similar to `O_EXCL` in POSIX.
Truncate file to size 0, similar to `O_TRUNC` in POSIX.
type link-counttype link-countu64
Number of hard links to an inode. -
record descriptor-statrecord descriptor-statFile attributes.
Note: This was called filestat in earlier versions of WASI.
type: descriptor-type
File type.
Number of hard links to the file.
size: filesize
For regular files, the file size in bytes. For symbolic links, the length in bytes of the pathname contained in the symbolic link.
data-access-timestamp: option<datetime>
data-access-timestamp: option<datetime>
Last data access timestamp.
If the option is none, the platform doesn't maintain an access
timestamp for this file.
data-modification-timestamp: option<datetime>
data-modification-timestamp: option<datetime>
Last data modification timestamp.
If the option is none, the platform doesn't maintain a
modification timestamp for this file.
status-change-timestamp: option<datetime>
status-change-timestamp: option<datetime>
Last file status-change timestamp.
If the option is none, the platform doesn't maintain a
status-change timestamp for this file.
variant new-timestampvariant new-timestampWhen setting a timestamp, this gives the value to set it to.
Leave the timestamp set to its previous value.
Set the timestamp to the current time of the system clock associated with the filesystem.
timestamp: datetime
Set the timestamp to the given value.
record directory-entryrecord directory-entryA directory entry.
type: descriptor-type
The type of the file referred to by this directory entry.
name: string
The name of the object.
enum error-codeenum error-codeError codes returned by functions, similar to errno in POSIX.
Not all of these error codes are returned by the functions provided by this
API; some are used in higher-level library layers, and others are provided
@@ -925,211 +924,211 @@ merely for alignment with POSIX.
Permission denied, similar to `EACCES` in POSIX.
Resource unavailable, or operation would block, similar to `EAGAIN` and `EWOULDBLOCK` in POSIX.
Connection already in progress, similar to `EALREADY` in POSIX.
Bad descriptor, similar to `EBADF` in POSIX.
Device or resource busy, similar to `EBUSY` in POSIX.
Resource deadlock would occur, similar to `EDEADLK` in POSIX.
Storage quota exceeded, similar to `EDQUOT` in POSIX.
File exists, similar to `EEXIST` in POSIX.
File too large, similar to `EFBIG` in POSIX.
Illegal byte sequence, similar to `EILSEQ` in POSIX.
Operation in progress, similar to `EINPROGRESS` in POSIX.
Interrupted function, similar to `EINTR` in POSIX.
Invalid argument, similar to `EINVAL` in POSIX.
I/O error, similar to `EIO` in POSIX.
Is a directory, similar to `EISDIR` in POSIX.
Too many levels of symbolic links, similar to `ELOOP` in POSIX.
Too many links, similar to `EMLINK` in POSIX.
Message too large, similar to `EMSGSIZE` in POSIX.
Filename too long, similar to `ENAMETOOLONG` in POSIX.
No such device, similar to `ENODEV` in POSIX.
No such file or directory, similar to `ENOENT` in POSIX.
No locks available, similar to `ENOLCK` in POSIX.
Not enough space, similar to `ENOMEM` in POSIX.
No space left on device, similar to `ENOSPC` in POSIX.
Not a directory or a symbolic link to a directory, similar to `ENOTDIR` in POSIX.
Directory not empty, similar to `ENOTEMPTY` in POSIX.
State not recoverable, similar to `ENOTRECOVERABLE` in POSIX.
Not supported, similar to `ENOTSUP` and `ENOSYS` in POSIX.
Inappropriate I/O control operation, similar to `ENOTTY` in POSIX.
No such device or address, similar to `ENXIO` in POSIX.
Value too large to be stored in data type, similar to `EOVERFLOW` in POSIX.
Operation not permitted, similar to `EPERM` in POSIX.
Broken pipe, similar to `EPIPE` in POSIX.
Read-only file system, similar to `EROFS` in POSIX.
Invalid seek, similar to `ESPIPE` in POSIX.
Text file busy, similar to `ETXTBSY` in POSIX.
Cross-device link, similar to `EXDEV` in POSIX.
enum adviceenum adviceFile or memory access pattern advisory information.
The application has no advice to give on its behavior with respect to the specified data.
The application expects to access the specified data sequentially from lower offsets to higher offsets.
The application expects to access the specified data in a random order.
The application expects to access the specified data in the near future.
The application expects that it will not access the specified data in the near future.
The application expects to access the specified data once and then not reuse it thereafter.
record metadata-hash-valuerecord metadata-hash-valueA 128-bit hash value, split into parts because wasm doesn't have a 128-bit integer type.
lower: u64
64 bits of a 128-bit hash value.
upper: u64
Another 64 bits of a 128-bit hash value.
resource descriptorresource descriptorA descriptor is a reference to a filesystem object, which may be a file, directory, named pipe, special file, or other object on which filesystem calls may be made.
-resource directory-entry-streamresource directory-entry-stream[method]descriptor.read-via-stream: func[method]descriptor.read-via-stream: funcReturn a stream for reading from a file, if available.
May fail with an error-code describing why the file cannot be read.
Multiple read, write, and append streams may be active on the same open @@ -1137,81 +1136,81 @@ file and they do not interfere with each other.
Note: This allows using read-stream, which is similar to read in POSIX.
self: borrow<descriptor>offset: filesizeself: borrow<descriptor>offset: filesizeinput-stream>, error-code>input-stream>, error-code>[method]descriptor.write-via-stream: func[method]descriptor.write-via-stream: funcReturn a stream for writing to a file, if available.
May fail with an error-code describing why the file cannot be written.
Note: This allows using write-stream, which is similar to write in
POSIX.
self: borrow<descriptor>offset: filesizeself: borrow<descriptor>offset: filesizeoutput-stream>, error-code>output-stream>, error-code>[method]descriptor.append-via-stream: func[method]descriptor.append-via-stream: funcReturn a stream for appending to a file, if available.
May fail with an error-code describing why the file cannot be appended.
Note: This allows using write-stream, which is similar to write with
O_APPEND in in POSIX.
self: borrow<descriptor>self: borrow<descriptor>output-stream>, error-code>output-stream>, error-code>[method]descriptor.advise: func[method]descriptor.advise: funcProvide file advisory information on a descriptor.
This is similar to posix_fadvise in POSIX.
self: borrow<descriptor>offset: filesizelength: filesizeadvice: adviceself: borrow<descriptor>offset: filesizelength: filesizeadvice: adviceerror-code>error-code>[method]descriptor.sync-data: func[method]descriptor.sync-data: funcSynchronize the data of a file to disk.
This function succeeds with no effect if the file descriptor is not opened for writing.
Note: This is similar to fdatasync in POSIX.
self: borrow<descriptor>self: borrow<descriptor>error-code>error-code>[method]descriptor.get-flags: func[method]descriptor.get-flags: funcGet flags associated with a descriptor.
Note: This returns similar flags to fcntl(fd, F_GETFL) in POSIX.
Note: This returns the value that was the fs_flags value returned
from fdstat_get in earlier versions of WASI.
self: borrow<descriptor>self: borrow<descriptor>descriptor-flags, error-code>descriptor-flags, error-code>[method]descriptor.get-type: func[method]descriptor.get-type: funcGet the dynamic type of a descriptor.
Note: This returns the same value as the type field of the fd-stat
returned by stat, stat-at and similar.
fstat in POSIX.
from fdstat_get in earlier versions of WASI.
self: borrow<descriptor>self: borrow<descriptor>descriptor-type, error-code>descriptor-type, error-code>[method]descriptor.set-size: func[method]descriptor.set-size: funcAdjust the size of an open file. If this increases the file's size, the extra bytes are filled with zeros.
Note: This was called fd_filestat_set_size in earlier versions of WASI.
self: borrow<descriptor>size: filesizeself: borrow<descriptor>size: filesizeerror-code>error-code>[method]descriptor.set-times: func[method]descriptor.set-times: funcAdjust the timestamps of an open file or directory.
Note: This is similar to futimens in POSIX.
Note: This was called fd_filestat_set_times in earlier versions of WASI.
self: borrow<descriptor>data-access-timestamp: new-timestampdata-modification-timestamp: new-timestampself: borrow<descriptor>data-access-timestamp: new-timestampdata-modification-timestamp: new-timestamperror-code>error-code>[method]descriptor.read: func[method]descriptor.read: funcRead from a descriptor, without using and updating the descriptor's offset.
This function returns a list of bytes containing the data that was read, along with a bool which, when true, indicates that the end of the @@ -1265,15 +1264,15 @@ if the I/O operation is interrupted.
Note: This is similar to pread in POSIX.
self: borrow<descriptor>length: filesizeoffset: filesizeself: borrow<descriptor>length: filesizeoffset: filesizeu8>, bool), error-code>u8>, bool), error-code>[method]descriptor.write: func[method]descriptor.write: funcWrite to a descriptor, without using and updating the descriptor's offset.
It is valid to write past the end of a file; the file is extended to the extent of the write, with bytes between the previous end and the start of @@ -1282,15 +1281,15 @@ the write set to zero.
Note: This is similar to pwrite in POSIX.
self: borrow<descriptor>buffer: list<u8>offset: filesizeself: borrow<descriptor>buffer: list<u8>offset: filesizefilesize, error-code>filesize, error-code>[method]descriptor.read-directory: func[method]descriptor.read-directory: funcRead directory entries from a directory.
On filesystems where directories contain entries referring to themselves
and their parents, often named . and .. respectively, these entries
@@ -1300,38 +1299,38 @@ directory. Multiple streams may be active on the same directory, and they
do not interfere with each other.
self: borrow<descriptor>self: borrow<descriptor>directory-entry-stream>, error-code>directory-entry-stream>, error-code>[method]descriptor.sync: func[method]descriptor.sync: funcSynchronize the data and metadata of a file to disk.
This function succeeds with no effect if the file descriptor is not opened for writing.
Note: This is similar to fsync in POSIX.
self: borrow<descriptor>self: borrow<descriptor>error-code>error-code>[method]descriptor.create-directory-at: func[method]descriptor.create-directory-at: funcCreate a directory.
Note: This is similar to mkdirat in POSIX.
self: borrow<descriptor>path: stringself: borrow<descriptor>path: stringerror-code>error-code>[method]descriptor.stat: func[method]descriptor.stat: funcReturn the attributes of an open file or directory.
Note: This is similar to fstat in POSIX, except that it does not return
device and inode information. For testing whether two descriptors refer to
@@ -1341,13 +1340,13 @@ modified, use metadata-hash.
Note: This was called fd_filestat_get in earlier versions of WASI.
self: borrow<descriptor>self: borrow<descriptor>descriptor-stat, error-code>descriptor-stat, error-code>[method]descriptor.stat-at: func[method]descriptor.stat-at: funcReturn the attributes of a file or directory.
Note: This is similar to fstatat in POSIX, except that it does not
return device and inode information. See the stat description for a
@@ -1355,47 +1354,47 @@ discussion of alternatives.
Note: This was called path_filestat_get in earlier versions of WASI.
self: borrow<descriptor>path-flags: path-flagspath: stringself: borrow<descriptor>path-flags: path-flagspath: stringdescriptor-stat, error-code>descriptor-stat, error-code>[method]descriptor.set-times-at: func[method]descriptor.set-times-at: funcAdjust the timestamps of a file or directory.
Note: This is similar to utimensat in POSIX.
Note: This was called path_filestat_set_times in earlier versions of
WASI.
self: borrow<descriptor>path-flags: path-flagspath: stringdata-access-timestamp: new-timestampdata-modification-timestamp: new-timestampself: borrow<descriptor>path-flags: path-flagspath: stringdata-access-timestamp: new-timestampdata-modification-timestamp: new-timestamperror-code>error-code>[method]descriptor.link-at: func[method]descriptor.link-at: funcCreate a hard link.
Note: This is similar to linkat in POSIX.
self: borrow<descriptor>old-path-flags: path-flagsold-path: stringnew-descriptor: borrow<descriptor>new-path: stringself: borrow<descriptor>old-path-flags: path-flagsold-path: stringnew-descriptor: borrow<descriptor>new-path: stringerror-code>error-code>[method]descriptor.open-at: func[method]descriptor.open-at: funcOpen a file or directory.
The returned descriptor is not guaranteed to be the lowest-numbered
descriptor not currently open/ it is randomized to prevent applications
@@ -1412,86 +1411,86 @@ contains truncate or create, and the base descriptor d
Note: This is similar to openat in POSIX.
self: borrow<descriptor>path-flags: path-flagspath: stringopen-flags: open-flagsflags: descriptor-flagsself: borrow<descriptor>path-flags: path-flagspath: stringopen-flags: open-flagsflags: descriptor-flagsdescriptor>, error-code>descriptor>, error-code>[method]descriptor.readlink-at: func[method]descriptor.readlink-at: funcRead the contents of a symbolic link.
If the contents contain an absolute or rooted path in the underlying
filesystem, this function fails with error-code::not-permitted.
Note: This is similar to readlinkat in POSIX.
self: borrow<descriptor>path: stringself: borrow<descriptor>path: stringstring, error-code>string, error-code>[method]descriptor.remove-directory-at: func[method]descriptor.remove-directory-at: funcRemove a directory.
Return error-code::not-empty if the directory is not empty.
Note: This is similar to unlinkat(fd, path, AT_REMOVEDIR) in POSIX.
self: borrow<descriptor>path: stringself: borrow<descriptor>path: stringerror-code>error-code>[method]descriptor.rename-at: func[method]descriptor.rename-at: funcRename a filesystem object.
Note: This is similar to renameat in POSIX.
self: borrow<descriptor>old-path: stringnew-descriptor: borrow<descriptor>new-path: stringself: borrow<descriptor>old-path: stringnew-descriptor: borrow<descriptor>new-path: stringerror-code>error-code>[method]descriptor.symlink-at: func[method]descriptor.symlink-at: funcCreate a symbolic link (also known as a "symlink").
If old-path starts with /, the function fails with
error-code::not-permitted.
Note: This is similar to symlinkat in POSIX.
self: borrow<descriptor>old-path: stringnew-path: stringself: borrow<descriptor>old-path: stringnew-path: stringerror-code>error-code>[method]descriptor.unlink-file-at: func[method]descriptor.unlink-file-at: funcUnlink a filesystem object that is not a directory.
Return error-code::is-directory if the path refers to a directory.
Note: This is similar to unlinkat(fd, path, 0) in POSIX.
self: borrow<descriptor>path: stringself: borrow<descriptor>path: stringerror-code>error-code>[method]descriptor.is-same-object: func[method]descriptor.is-same-object: funcTest whether two descriptors refer to the same filesystem object.
In POSIX, this corresponds to testing whether the two descriptors have the
same device (st_dev) and inode (st_ino or d_ino) numbers.
@@ -1499,14 +1498,14 @@ wasi-filesystem does not expose device and inode numbers, so this function
may be used instead.
self: borrow<descriptor>other: borrow<descriptor>self: borrow<descriptor>other: borrow<descriptor>[method]descriptor.metadata-hash: func[method]descriptor.metadata-hash: funcReturn a hash of the metadata associated with a filesystem object referred to by a descriptor.
This returns a hash of the last-modification timestamp and file size, and @@ -1526,37 +1525,37 @@ computed hash.
However, none of these is required.
self: borrow<descriptor>self: borrow<descriptor>metadata-hash-value, error-code>metadata-hash-value, error-code>[method]descriptor.metadata-hash-at: func[method]descriptor.metadata-hash-at: funcReturn a hash of the metadata associated with a filesystem object referred to by a directory descriptor and a relative path.
This performs the same hash computation as metadata-hash.
self: borrow<descriptor>path-flags: path-flagspath: stringself: borrow<descriptor>path-flags: path-flagspath: stringmetadata-hash-value, error-code>metadata-hash-value, error-code>[method]directory-entry-stream.read-directory-entry: func[method]directory-entry-stream.read-directory-entry: funcRead a single directory entry from a directory-entry-stream.
self: borrow<directory-entry-stream>self: borrow<directory-entry-stream>directory-entry>, error-code>directory-entry>, error-code>filesystem-error-code: funcfilesystem-error-code: funcAttempts to extract a filesystem-related error-code from the stream
error provided.
Stream operations which return stream-error::last-operation-failed
@@ -1567,34 +1566,34 @@ filesystem-related information about the error to return.
error-code>type descriptortype descriptor----
get-directories: funcget-directories: funcReturn the set of preopened directories, and their path.
descriptor>, string)>resource networkresource networkAn opaque resource that represents access to (a subset of) the network. This enables context-based security for networking. There is no need for this to map 1:1 to a physical network interface.
-enum error-codeenum error-codeError codes.
In theory, every API can return any error code. In practice, API's typically only return the errors documented per API @@ -1610,235 +1609,235 @@ combined with a couple of errors that are always possible:
Unknown error
Access denied.
POSIX equivalent: EACCES, EPERM
The operation is not supported.
POSIX equivalent: EOPNOTSUPP
One of the arguments is invalid.
POSIX equivalent: EINVAL
Not enough memory to complete the operation.
POSIX equivalent: ENOMEM, ENOBUFS, EAI_MEMORY
The operation timed out before it could finish completely.
This operation is incompatible with another asynchronous operation that is already in progress.
POSIX equivalent: EALREADY
Trying to finish an asynchronous operation that: - has not been started yet, or: - was already finished by a previous `finish-*` call.
Note: this is scheduled to be removed when futures are natively supported.
The operation has been aborted because it could not be completed immediately.
Note: this is scheduled to be removed when futures are natively supported.
The operation is not valid in the socket's current state.
A new socket resource could not be created because of a system limit.
A bind operation failed because the provided address is not an address that the `network` can bind to.
A bind operation failed because the provided address is already in use or because there are no ephemeral ports available.
The remote address is not reachable
The TCP connection was forcefully rejected
The TCP connection was reset.
A TCP connection was aborted.
The size of a datagram sent to a UDP socket exceeded the maximum supported size.
Name does not exist or has no suitable associated IP addresses.
A temporary failure in name resolution occurred.
A permanent failure in name resolution occurred.
enum ip-address-familyenum ip-address-familytuple ipv4-addresstuple ipv4-addresstuple ipv6-addresstuple ipv6-address0: u161: u162: u163: u164: u165: u166: u167: u160: u161: u162: u163: u164: u165: u166: u167: u16variant ip-addressvariant ip-addressipv4: ipv4-addressipv6: ipv6-addressipv4: ipv4-addressipv6: ipv6-addressrecord ipv4-socket-addressrecord ipv4-socket-addressport: u16
sin_port
address: ipv4-address
sin_addr
record ipv6-socket-addressrecord ipv6-socket-addressport: u16
sin6_port
flow-info: u32
sin6_flowinfo
address: ipv6-address
sin6_addr
scope-id: u32
sin6_scope_id
variant ip-socket-addressvariant ip-socket-addressipv4: ipv4-socket-addressipv6: ipv6-socket-addressipv4: ipv4-socket-addressipv6: ipv6-socket-addressThis interface provides a value-export of the default network handle..
type networktype network----
instance-network: funcinstance-network: funcGet a handle to the default network.
network>type pollabletype pollable-#### `type network` +#### `type network` [`network`](#network)
-#### `type error-code` +#### `type error-code` [`error-code`](#error_code)
-#### `type ip-socket-address` +#### `type ip-socket-address` [`ip-socket-address`](#ip_socket_address)
-#### `type ip-address-family` +#### `type ip-address-family` [`ip-address-family`](#ip_address_family)
-#### `record incoming-datagram` +#### `record incoming-datagram`
A received datagram.
data: list<u8>
The payload.
Theoretical max size: ~64 KiB. In practice, typically less than 1500 bytes.
remote-address: ip-socket-address
remote-address: ip-socket-address
The source address.
This field is guaranteed to match the remote address the stream was initialized with, if any.
Equivalent to the src_addr out parameter of recvfrom.
record outgoing-datagramrecord outgoing-datagramA datagram to be sent out.
data: list<u8>
The payload.
remote-address: option<ip-socket-address>
remote-address: option<ip-socket-address>
The destination address.
The requirements on this field depend on how the stream was initialized:
If this value is None, the send operation is equivalent to send in POSIX. Otherwise it is equivalent to sendto.
resource udp-socketresource udp-socketA UDP socket handle.
-resource incoming-datagram-streamresource outgoing-datagram-streamresource incoming-datagram-streamresource outgoing-datagram-stream[method]udp-socket.start-bind: func[method]udp-socket.start-bind: funcBind the socket to a specific network on the provided IP address and port.
If the IP address is zero (0.0.0.0 in IPv4, :: in IPv6), it is left to the implementation to decide which
network interface(s) to bind to.
@@ -1883,24 +1882,24 @@ don't want to make use of this ability can simply call the native
self: borrow<udp-socket>network: borrow<network>local-address: ip-socket-addressself: borrow<udp-socket>network: borrow<network>local-address: ip-socket-addresserror-code>error-code>[method]udp-socket.finish-bind: func[method]udp-socket.finish-bind: funcself: borrow<udp-socket>self: borrow<udp-socket>error-code>error-code>[method]udp-socket.stream: func[method]udp-socket.stream: funcSet up inbound & outbound communication channels, optionally to a specific peer.
This function only changes the local socket configuration and does not generate any network traffic.
On success, the remote-address of the socket is updated. The local-address may be updated as well,
@@ -1941,14 +1940,14 @@ if (remote_address is Some) {
self: borrow<udp-socket>remote-address: option<ip-socket-address>self: borrow<udp-socket>remote-address: option<ip-socket-address>incoming-datagram-stream>, own<outgoing-datagram-stream>), error-code>incoming-datagram-stream>, own<outgoing-datagram-stream>), error-code>[method]udp-socket.local-address: func[method]udp-socket.local-address: funcGet the current bound address.
POSIX mentions: