Struct wasi_common::pipe::ReadPipe

pub struct ReadPipe<R: Read> { /* fields omitted */ }

A virtual pipe read end.

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

use wasi_common::{pipe::ReadPipe, WasiCtx, Table};
let stdin = ReadPipe::from("hello from stdin!");
// Brint these instances from elsewhere (e.g. wasi-cap-std-sync):
let random = todo!();
let clocks = todo!();
let sched = todo!();
let table = Rc::new(RefCell::new(Table::new()));
let mut ctx = WasiCtx::new(random, clocks, sched, table);
ctx.set_stdin(Box::new(stdin.clone()));

Implementations

impl<R: Read> 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> 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> 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

Performs the conversion.

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

fn from(r: &str) -> Self

Performs the conversion.

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

fn from(r: String) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

fn as_any(&self) -> &dyn Any

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

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

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

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

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

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

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

fn advise<'life0, 'async_trait>(
    &'life0 self,
    offset: u64,
    len: u64,
    advice: Advice
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

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

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

fn write_vectored<'a, 'life0, 'life1, 'async_trait>(
    &'life0 self,
    bufs: &'life1 [IoSlice<'a>]
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn write_vectored_at<'a, 'life0, 'life1, 'async_trait>(
    &'life0 self,
    bufs: &'life1 [IoSlice<'a>],
    offset: u64
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

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

fn set_times<'life0, 'async_trait>(
    &'life0 self,
    atime: Option<SystemTimeSpec>,
    mtime: Option<SystemTimeSpec>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

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

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