Struct wasm_streams::readable::IntoAsyncRead

pub struct IntoAsyncRead<'reader> { /* fields omitted */ }

An AsyncRead for the into_async_read method.

This AsyncRead holds a reader, and therefore locks the ReadableStream. When this AsyncRead is dropped, it also drops its reader which in turn releases its lock.

When used through ReadableStream::into_async_read, the stream is automatically cancelled before dropping the reader, discarding any pending read requests. When used through ReadableStreamBYOBReader::into_async_read, it is up to the user to either manually cancel the stream, or to ensure that there are no pending read requests when dropped. See the documentation on ReadableStreamBYOBReader for more details on the drop behavior.

Implementations

impl<'reader> IntoAsyncRead<'reader>

pub async fn cancel(self) -> Result<(), JsValue>

Cancels the stream, signaling a loss of interest in the stream by a consumer.

pub async fn cancel_with_reason(self, reason: &JsValue) -> Result<(), JsValue>

Cancels the stream, signaling a loss of interest in the stream by a consumer.

Trait Implementations

impl<'reader> AsyncRead for IntoAsyncRead<'reader>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'reader> Debug for IntoAsyncRead<'reader>

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

Formats the value using the given formatter.

impl<'reader> Drop for IntoAsyncRead<'reader>

fn drop(&mut self)

Executes the destructor for this type.