Struct wasmtime_wasi::preview2::pipe::ReadPipe

pub struct ReadPipe<R: Read + ReadReady> { /* private fields */ }

A virtual pipe read end.

This reads from a source that implements the Read trait. It also requires the ReadReady trait, which is implemented for many popular Read-implementing types and is easy to implemented for new types.

A variety of From impls are provided so that common pipe types are easy to create. For example:

use wasmtime_wasi::preview2::{pipe::ReadPipe, WasiCtx};
let stdin = ReadPipe::from("hello from stdin!");
let builder = WasiCtx::builder().set_stdin(stdin);

Implementations

impl<R: Read + ReadReady> ReadPipe<R>

pub fn new(r: R) -> Self

Create a new pipe from a Read type.

All Handle read operations delegate to reading from this underlying reader.

pub fn from_shared(reader: Arc<RwLock<R>>) -> Self

Create a new pipe from a shareable Read type.

All Handle read operations delegate to reading from this underlying reader.

pub fn try_into_inner(self) -> Result<R, Self>

Try to convert this ReadPipe<R> back to the underlying R type.

This will fail with Err(self) if multiple references to the underlying R exist.

Trait Implementations

impl<R: Read + ReadReady> Clone for ReadPipe<R>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug + Read + ReadReady> Debug for ReadPipe<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&[u8]> for ReadPipe<Cursor<Vec<u8>>>

fn from(r: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for ReadPipe<Cursor<String>>

fn from(r: &str) -> Self

Converts to this type from the input type.

impl From<String> for ReadPipe<Cursor<String>>

fn from(r: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for ReadPipe<Cursor<Vec<u8>>>

fn from(r: Vec<u8>) -> Self

Converts to this type from the input type.

impl<R: Read + ReadReady + Any + Send + Sync> InputStream for ReadPipe<R>

fn as_any(&self) -> &dyn Any

fn num_ready_bytes<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Return the number of bytes that may be read without blocking.

fn read<'life0, 'life1, 'async_trait>( &'life0 mut self, buf: &'life1 mut [u8] ) -> Pin<Box<dyn Future<Output = Result<(u64, bool), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read bytes. On success, returns a pair holding the number of bytes read and a flag indicating whether the end of the stream was reached.

fn skip<'life0, 'async_trait>( &'life0 mut self, nelem: u64 ) -> Pin<Box<dyn Future<Output = Result<(u64, bool), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Read bytes from a stream and discard them.

fn readable<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Test whether this stream is readable.

fn pollable_read(&self) -> Option<BorrowedFd<'_>>

If this stream is reading from a host file descriptor, return it so that it can be polled with a host poll.

fn read_vectored<'a, 'life0, 'life1, 'async_trait>( &'life0 mut self, _bufs: &'life1 mut [IoSliceMut<'a>] ) -> Pin<Box<dyn Future<Output = Result<(u64, bool), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Vectored-I/O form of read.

fn is_read_vectored(&self) -> bool

Test whether vectored I/O reads are known to be optimized in the underlying implementation.