Struct async_stdio::AsStdIo

pub struct AsStdIo<S> { /* fields omitted */ }

Adapter to use an async byte stream as a std::io::{Read, Write} type

For correct operation, WakerCtrl::register must be called before any calls to read or write. If the async stream would return Poll::Pending, it will be converted to an io::ErrorKind::WouldBlock error.

Methods

impl<S> AsStdIo<S>

pub fn new(stream: S, waker: Option<&Waker>) -> (Self, WakerCtrl)

Wrap the async stream and initialize the wrapper with the provided waker.

If no waker is provided, it will be initialized with a no-op waker.

Also returns a handle that can be used to control the waker.

pub fn with_context<F, T>(&mut self, f: F) -> T where
    F: for<'c> FnOnce(Pin<&mut S>, &mut Context<'c>) -> T,
    S: Unpin, 

Get a pinned reference to the internal stream and a context with which to poll it.

Sometimes useful if you need to perform some operation such as [AsyncWrite::close] on it which doesn't have an std counterpart.

Trait Implementations

impl<S> Deref for AsStdIo<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> DerefMut for AsStdIo<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<S: Debug> Debug for AsStdIo<S>

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

Formats the value using the given formatter.

impl<S> Write for AsStdIo<S> where
    S: AsyncWrite + Unpin, 

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

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

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<S> Read for AsStdIo<S> where
    S: AsyncRead + Unpin, 

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.