1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
use crate::preview2::filesystem::FileInputStream;
use crate::preview2::poll::Subscribe;
use anyhow::Result;
use bytes::Bytes;
/// Host trait for implementing the `wasi:io/streams.input-stream` resource: A
/// bytestream which can be read from.
#[async_trait::async_trait]
pub trait HostInputStream: Subscribe {
/// Reads up to `size` bytes, returning a buffer holding these bytes on
/// success.
///
/// This function does not block the current thread and is the equivalent of
/// a non-blocking read. On success all bytes read are returned through
/// `Bytes`, which is no larger than the `size` provided. If the returned
/// list of `Bytes` is empty then no data is ready to be read at this time.
///
/// # Errors
///
/// The [`StreamError`] return value communicates when this stream is
/// closed, when a read fails, or when a trap should be generated.
fn read(&mut self, size: usize) -> StreamResult<Bytes>;
/// Same as the `read` method except that bytes are skipped.
///
/// Note that this method is non-blocking like `read` and returns the same
/// errors.
fn skip(&mut self, nelem: usize) -> StreamResult<usize> {
let bs = self.read(nelem)?;
Ok(bs.len())
}
}
/// Representation of the `error` resource type in the `wasi:io/error`
/// interface.
///
/// This is currently `anyhow::Error` to retain full type information for
/// errors.
pub type Error = anyhow::Error;
pub type StreamResult<T> = Result<T, StreamError>;
#[derive(Debug)]
pub enum StreamError {
Closed,
LastOperationFailed(anyhow::Error),
Trap(anyhow::Error),
}
impl StreamError {
pub fn trap(msg: &str) -> StreamError {
StreamError::Trap(anyhow::anyhow!("{msg}"))
}
}
impl std::fmt::Display for StreamError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
StreamError::Closed => write!(f, "closed"),
StreamError::LastOperationFailed(e) => write!(f, "last operation failed: {e}"),
StreamError::Trap(e) => write!(f, "trap: {e}"),
}
}
}
impl std::error::Error for StreamError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
StreamError::Closed => None,
StreamError::LastOperationFailed(e) | StreamError::Trap(e) => e.source(),
}
}
}
impl From<wasmtime::component::ResourceTableError> for StreamError {
fn from(error: wasmtime::component::ResourceTableError) -> Self {
Self::Trap(error.into())
}
}
/// Host trait for implementing the `wasi:io/streams.output-stream` resource:
/// A bytestream which can be written to.
#[async_trait::async_trait]
pub trait HostOutputStream: Subscribe {
/// Write bytes after obtaining a permit to write those bytes
///
/// Prior to calling [`write`](Self::write) the caller must call
/// [`check_write`](Self::check_write), which resolves to a non-zero permit
///
/// This method must never block. The [`check_write`](Self::check_write)
/// permit indicates the maximum amount of bytes that are permitted to be
/// written in a single [`write`](Self::write) following the
/// [`check_write`](Self::check_write) resolution.
///
/// # Errors
///
/// Returns a [`StreamError`] if:
/// - stream is closed
/// - prior operation ([`write`](Self::write) or [`flush`](Self::flush)) failed
/// - caller performed an illegal operation (e.g. wrote more bytes than were permitted)
fn write(&mut self, bytes: Bytes) -> StreamResult<()>;
/// Trigger a flush of any bytes buffered in this stream implementation.
///
/// This method may be called at any time and must never block.
///
/// After this method is called, [`check_write`](Self::check_write) must
/// pend until flush is complete.
///
/// When [`check_write`](Self::check_write) becomes ready after a flush,
/// that guarantees that all prior writes have been flushed from the
/// implementation successfully, or that any error associated with those
/// writes is reported in the return value of [`flush`](Self::flush) or
/// [`check_write`](Self::check_write)
///
/// # Errors
///
/// Returns a [`StreamError`] if:
/// - stream is closed
/// - prior operation ([`write`](Self::write) or [`flush`](Self::flush)) failed
/// - caller performed an illegal operation (e.g. wrote more bytes than were permitted)
fn flush(&mut self) -> StreamResult<()>;
/// Returns the number of bytes that are ready to be written to this stream.
///
/// Zero bytes indicates that this stream is not currently ready for writing
/// and `ready()` must be awaited first.
///
/// Note that this method does not block.
///
/// # Errors
///
/// Returns an [`StreamError`] if:
/// - stream is closed
/// - prior operation ([`write`](Self::write) or [`flush`](Self::flush)) failed
fn check_write(&mut self) -> StreamResult<usize>;
/// Repeatedly write a byte to a stream.
/// Important: this write must be non-blocking!
/// Returning an Err which downcasts to a [`StreamError`] will be
/// reported to Wasm as the empty error result. Otherwise, errors will trap.
fn write_zeroes(&mut self, nelem: usize) -> StreamResult<()> {
// TODO: We could optimize this to not allocate one big zeroed buffer, and instead write
// repeatedly from a 'static buffer of zeros.
let bs = Bytes::from_iter(core::iter::repeat(0).take(nelem));
self.write(bs)?;
Ok(())
}
/// Simultaneously waits for this stream to be writable and then returns how
/// much may be written or the last error that happened.
async fn write_ready(&mut self) -> StreamResult<usize> {
self.ready().await;
self.check_write()
}
}
#[async_trait::async_trait]
impl Subscribe for Box<dyn HostOutputStream> {
async fn ready(&mut self) {
(**self).ready().await
}
}
pub enum InputStream {
Host(Box<dyn HostInputStream>),
File(FileInputStream),
}
#[async_trait::async_trait]
impl Subscribe for InputStream {
async fn ready(&mut self) {
match self {
InputStream::Host(stream) => stream.ready().await,
// Files are always ready
InputStream::File(_) => {}
}
}
}
pub type OutputStream = Box<dyn HostOutputStream>;