Struct wasi_common::pipe::ReadPipe

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

Expand description

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

Implementations

Create a new pipe from a Read type.

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

Create a new pipe from a shareable Read type.

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

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct wasi_common::pipe::ReadPipe

Implementations

impl<R: Read> ReadPipe<R>

pub fn new(r: R) -> Self

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

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

Trait Implementations

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

fn clone(&self) -> Self

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

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

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

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

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

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

fn from(r: &str) -> Self

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

fn from(r: String) -> Self

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

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

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

fn as_any(&self) -> &dyn Any

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

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

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

fn isatty(&mut self) -> bool

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

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

fn sock_send<'a, 'life0, 'life1, 'async_trait>( &'life0 mut self, _si_data: &'life1 [IoSlice<'a>], _si_flags: SiFlags) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

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

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

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

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

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

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

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

fn advise<'life0, 'async_trait>( &'life0 mut self, _offset: u64, _len: u64, _advice: Advice) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

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

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

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

fn write_vectored<'a, 'life0, 'life1, 'async_trait>( &'life0 mut self, _bufs: &'life1 [IoSlice<'a>]) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + '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 mut self, _bufs: &'life1 [IoSlice<'a>], _offset: u64) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where 'a: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

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

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

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

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

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

Auto Trait Implementations

impl<R> RefUnwindSafe for ReadPipe<R>

impl<R> Send for ReadPipe<R> where R: Send + Sync,

impl<R> Sync for ReadPipe<R> where R: Send + Sync,

impl<R> Unpin for ReadPipe<R>

impl<R> UnwindSafe for ReadPipe<R>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Pointee for T

type Pointer = u32

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>) -> Result<(), Error>

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

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

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

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

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

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

fn sock_send<'a, 'life0, 'life1, 'async_trait>(
&'life0 mut self,
_si_data: &'life1 [IoSlice<'a>],
_si_flags: SiFlags
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

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

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

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

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

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

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

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

fn advise<'life0, 'async_trait>(
&'life0 mut self,
_offset: u64,
_len: u64,
_advice: Advice
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

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

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

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

fn write_vectored<'a, 'life0, 'life1, 'async_trait>(
&'life0 mut self,
_bufs: &'life1 [IoSlice<'a>]
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + '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 mut self,
_bufs: &'life1 [IoSlice<'a>],
_offset: u64
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

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

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

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

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

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

impl<R> Send for ReadPipe<R> where
R: Send + Sync,

impl<R> Sync for ReadPipe<R> where
R: Send + Sync,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

fn debug(
pointer: <T as Pointee>::Pointer,
f: &mut Formatter<'_>
) -> Result<(), Error>

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,