Skip to content

Commit

Permalink
Add semicolons in WIT files (#49)
Browse files Browse the repository at this point in the history
For more information see WebAssembly/component-model#249.
  • Loading branch information
alexcrichton authored Oct 6, 2023
1 parent 1f37cec commit 88e3e44
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: WebAssembly/wit-abi-up-to-date@v15
- uses: WebAssembly/wit-abi-up-to-date@v16
8 changes: 4 additions & 4 deletions wit/poll.wit
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package wasi:io
package wasi:io;

/// A poll API intended to let users wait for I/O events on multiple handles
/// at once.
interface poll {
/// A "pollable" handle.
resource pollable
resource pollable;

/// Poll for completion on a set of pollables.
///
Expand All @@ -24,11 +24,11 @@ interface poll {
/// 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.
poll-list: func(in: list<borrow<pollable>>) -> list<u32>
poll-list: func(in: list<borrow<pollable>>) -> list<u32>;

/// Poll for completion on a single pollable.
///
/// This function is similar to `poll-list`, but operates on only a single
/// pollable. When it returns, the handle is ready for I/O.
poll-one: func(in: borrow<pollable>)
poll-one: func(in: borrow<pollable>);
}
36 changes: 18 additions & 18 deletions wit/streams.wit
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package wasi:io
package wasi:io;

/// 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.
interface streams {
use poll.{pollable}
use poll.{pollable};

/// Streams provide a sequence of data and then end; once they end, they
/// no longer provide any further data.
Expand Down Expand Up @@ -58,14 +58,14 @@ interface streams {
read: func(
/// The maximum number of bytes to read
len: u64
) -> result<tuple<list<u8>, stream-status>>
) -> result<tuple<list<u8>, stream-status>>;

/// Read bytes from a stream, after blocking until at least one byte can
/// be read. Except for blocking, identical to `read`.
blocking-read: func(
/// The maximum number of bytes to read
len: u64
) -> result<tuple<list<u8>, stream-status>>
) -> result<tuple<list<u8>, stream-status>>;

/// Skip bytes from a stream.
///
Expand All @@ -82,22 +82,22 @@ interface streams {
skip: func(
/// The maximum number of bytes to skip.
len: u64,
) -> result<tuple<u64, stream-status>>
) -> result<tuple<u64, stream-status>>;

/// Skip bytes from a stream, after blocking until at least one byte
/// can be skipped. Except for blocking behavior, identical to `skip`.
blocking-skip: func(
/// The maximum number of bytes to skip.
len: u64,
) -> result<tuple<u64, stream-status>>
) -> result<tuple<u64, stream-status>>;

/// Create 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.
/// The created `pollable` is a child resource of the `input-stream`.
/// Implementations may trap if the `input-stream` is dropped before
/// all derived `pollable`s created with this function are dropped.
subscribe: func() -> pollable
subscribe: func() -> pollable;
}

/// An error for output-stream operations.
Expand Down Expand Up @@ -131,7 +131,7 @@ interface streams {
/// When this function returns 0 bytes, the `subscribe` pollable will
/// become ready when this function will report at least 1 byte, or an
/// error.
check-write: func() -> result<u64, write-error>
check-write: func() -> result<u64, write-error>;

/// Perform a write. This function never blocks.
///
Expand All @@ -142,7 +142,7 @@ interface streams {
/// the last call to check-write provided a permit.
write: func(
contents: list<u8>
) -> result<_, write-error>
) -> result<_, write-error>;

/// Perform a write of up to 4096 bytes, and then flush the stream. Block
/// until all of these operations are complete, or an error occurs.
Expand Down Expand Up @@ -170,7 +170,7 @@ interface streams {
/// ```
blocking-write-and-flush: func(
contents: list<u8>
) -> result<_, write-error>
) -> result<_, write-error>;

/// Request to flush buffered output. This function never blocks.
///
Expand All @@ -182,11 +182,11 @@ interface streams {
/// writes (`check-write` will return `ok(0)`) until the flush has
/// completed. The `subscribe` pollable will become ready when the
/// flush has completed and the stream can accept more writes.
flush: func() -> result<_, write-error>
flush: func() -> result<_, write-error>;

/// Request to flush buffered output, and block until flush completes
/// and stream is ready for writing again.
blocking-flush: func() -> result<_, write-error>
blocking-flush: func() -> result<_, write-error>;

/// Create a `pollable` which will resolve once the output-stream
/// is ready for more writing, or an error has occured. When this
Expand All @@ -198,7 +198,7 @@ interface streams {
/// The created `pollable` is a child resource of the `output-stream`.
/// Implementations may trap if the `output-stream` is dropped before
/// all derived `pollable`s created with this function are dropped.
subscribe: func() -> pollable
subscribe: func() -> pollable;

/// Write zeroes to a stream.
///
Expand All @@ -209,7 +209,7 @@ interface streams {
write-zeroes: func(
/// The number of zero-bytes to write
len: u64
) -> result<_, write-error>
) -> result<_, write-error>;

/// Perform a write of up to 4096 zeroes, and then flush the stream.
/// Block until all of these operations are complete, or an error
Expand Down Expand Up @@ -238,7 +238,7 @@ interface streams {
blocking-write-zeroes-and-flush: func(
/// The number of zero-bytes to write
len: u64
) -> result<_, write-error>
) -> result<_, write-error>;

/// Read from one stream and write to another.
///
Expand All @@ -252,7 +252,7 @@ interface streams {
src: input-stream,
/// The number of bytes to splice
len: u64,
) -> result<tuple<u64, stream-status>>
) -> result<tuple<u64, stream-status>>;

/// Read from one stream and write to another, with blocking.
///
Expand All @@ -263,7 +263,7 @@ interface streams {
src: input-stream,
/// The number of bytes to splice
len: u64,
) -> result<tuple<u64, stream-status>>
) -> result<tuple<u64, stream-status>>;

/// Forward the entire contents of an input stream to an output stream.
///
Expand All @@ -280,6 +280,6 @@ interface streams {
forward: func(
/// The stream to read from
src: input-stream
) -> result<tuple<u64, stream-status>>
) -> result<tuple<u64, stream-status>>;
}
}
6 changes: 3 additions & 3 deletions wit/world.wit
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package wasi:io
package wasi:io;

world imports {
import streams
import poll
import streams;
import poll;
}

0 comments on commit 88e3e44

Please sign in to comment.