Struct AsyncAsSync

pub struct AsyncAsSync<'r, 'ctx, T> {
    pub context: &'r mut Context<'ctx>,
    pub inner: T,
}

A wrapper around a type that implements AsyncRead or AsyncWrite that converts Pending polls to WouldBlock errors.

This wrapper can be used as a compatibility layer between AsyncRead and Read, for types that take Read as a parameter.

Examples

use std::io::Read;
use std::task::{Poll, Context};

fn poll_for_io(cx: &mut Context<'_>) -> Poll<usize> {
    // Assume we have a library that's built around `Read` and `Write` traits.
    use cooltls::Session;

    // We want to use it with our writer that implements `AsyncWrite`.
    let writer = Stream::new();

    // First, we wrap our `Writer` with `AsyncAsSync` to convert `Pending` polls to `WouldBlock`.
    use futures_lite::io::AsyncAsSync;
    let writer = AsyncAsSync::new(cx, writer);

    // Now, we can use it with `cooltls`.
    let mut session = Session::new(writer);

    // Match on the result of `read()` and translate it to poll.
    match session.read(&mut [0; 1024]) {
        Ok(n) => Poll::Ready(n),
        Err(err) if err.kind() == std::io::ErrorKind::WouldBlock => Poll::Pending,
        Err(err) => panic!("unexpected error: {}", err),
    }
}

// Usually, poll-based functions are best wrapped using `poll_fn`.
use futures_lite::future::poll_fn;
poll_fn(|cx| poll_for_io(cx)).await;

Fields

context: &'r mut Context<'ctx>

The context we are using to poll the future.

inner: T

The actual reader/writer we are wrapping.

Implementations

impl<'r, 'ctx, T> AsyncAsSync<'r, 'ctx, T>

pub fn new(context: &'r mut Context<'ctx>, inner: T) -> AsyncAsSync<'r, 'ctx, T>

Wraps an I/O handle implementing AsyncRead or AsyncWrite traits.

Examples

use futures_lite::io::AsyncAsSync;
use std::task::Context;
use waker_fn::waker_fn;

let reader: &[u8] = b"hello";
let waker = waker_fn(|| {});
let mut context = Context::from_waker(&waker);

let async_reader = AsyncAsSync::new(&mut context, reader);

pub fn close(&mut self) -> Result<(), Error>

where T: AsyncWrite + Unpin,

Attempt to shutdown the I/O handle.

Examples

use futures_lite::io::AsyncAsSync;
use std::task::Context;
use waker_fn::waker_fn;

let reader: Vec<u8> = b"hello".to_vec();
let waker = waker_fn(|| {});
let mut context = Context::from_waker(&waker);

let mut async_reader = AsyncAsSync::new(&mut context, reader);
async_reader.close().unwrap();

pub fn poll_with<R>( &mut self, f: impl FnOnce(Pin<&mut T>, &mut Context<'_>) -> Poll<Result<R, Error>>, ) -> Result<R, Error>

where T: Unpin,

Poll this AsyncAsSync for some function.

Examples

use futures_lite::io::{AsyncAsSync, AsyncRead};
use std::task::Context;
use waker_fn::waker_fn;

let reader: &[u8] = b"hello";
let waker = waker_fn(|| {});
let mut context = Context::from_waker(&waker);

let mut async_reader = AsyncAsSync::new(&mut context, reader);
let r = async_reader.poll_with(|io, cx| io.poll_read(cx, &mut [0; 1024]));
assert_eq!(r.unwrap(), 5);

Trait Implementations

impl<T> AsMut<T> for AsyncAsSync<'_, '_, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for AsyncAsSync<'_, '_, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<T> for AsyncAsSync<'_, '_, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for AsyncAsSync<'_, '_, T>

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

Mutably borrows from an owned value.

impl<'r, 'ctx, T> Debug for AsyncAsSync<'r, 'ctx, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Read for AsyncAsSync<'_, '_, T>

where T: AsyncRead + Unpin,

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

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.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

impl<T> Seek for AsyncAsSync<'_, '_, T>

where T: AsyncSeek + Unpin,

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

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

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

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

Returns the length of this stream (in bytes).

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

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<T> Write for AsyncAsSync<'_, '_, T>

where T: AsyncWrite + Unpin,

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

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

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

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

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

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

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

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

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

Attempts to write multiple buffers 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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.