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 ctx = WasiCtx::builder(random, clocks, sched, table)
            .stdin(Box::new(stdin.clone()))
            .build();

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> WasiFile for ReadPipe<R>

fn as_any(&self) -> &dyn Any

fn datasync(&self) -> Result<(), Error>

fn sync(&self) -> Result<(), Error>

fn get_filetype(&self) -> Result<FileType, Error>

fn get_fdflags(&self) -> Result<FdFlags, Error>

fn set_fdflags(&mut self, _fdflags: FdFlags) -> Result<(), Error>

fn get_filestat(&self) -> Result<Filestat, Error>

fn set_filestat_size(&self, _size: u64) -> Result<(), Error>

fn advise(&self, offset: u64, len: u64, advice: Advice) -> Result<(), Error>

fn allocate(&self, offset: u64, len: u64) -> Result<(), Error>

fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> Result<u64, Error>

fn read_vectored_at(
    &self,
    bufs: &mut [IoSliceMut<'_>],
    offset: u64
) -> Result<u64, Error>

fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> Result<u64, Error>

fn write_vectored_at(
    &self,
    bufs: &[IoSlice<'_>],
    offset: u64
) -> Result<u64, Error>

fn seek(&self, pos: SeekFrom) -> Result<u64, Error>

fn peek(&self, buf: &mut [u8]) -> Result<u64, Error>

fn set_times(
    &self,
    atime: Option<SystemTimeSpec>,
    mtime: Option<SystemTimeSpec>
) -> Result<(), Error>

fn num_ready_bytes(&self) -> Result<u64, Error>