Struct BoxAsyncOutput 

pub struct BoxAsyncOutput<O>
where
    O: AsyncOutput + ?Sized,
{ /* private fields */ }

Adapts an owned pinned boxed asynchronous output, including a trait object.

Type Parameters

• O: The boxed asynchronous output type, which may be unsized and non-Unpin.

Implementations

impl<O> BoxAsyncOutput<O>

where O: AsyncOutput + ?Sized,

pub fn new(inner: Box<O>) -> Self

Creates an asynchronous output adapter around inner.

Parameters

• inner: Boxed asynchronous output to pin and adapt.

Returns

Returns an adapter that owns and pins inner.

pub fn get_ref(&self) -> &O

Returns a shared reference to the boxed asynchronous output.

Returns

Returns the wrapped asynchronous output.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut O>

Projects a pinned adapter to its pinned boxed asynchronous output.

Returns

Returns a pinned mutable reference to the wrapped output without moving it.

pub fn into_inner(self) -> Pin<Box<O>>

Consumes this adapter and returns its pinned boxed asynchronous output.

Returns

Returns the pinned boxed output so a potentially non-Unpin value stays pinned after extraction.

Trait Implementations

impl<O> AsyncClose for BoxAsyncOutput<O>

where O: AsyncClose + ?Sized,

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Forwards an asynchronous close to the pinned boxed output.

Parameters

• cx: Task context used to register a wake-up.

Returns

Returns a pending state or the wrapped output’s ready close result.

Errors

Returns an error reported while closing the wrapped output.

fn close_async(&mut self) -> CloseFuture<'_, Self>

where Self: Sized + Unpin,

Creates a future that closes this output.

impl<O> AsyncOutput for BoxAsyncOutput<O>

where O: AsyncOutput + ?Sized,

type Item = <O as AsyncOutput>::Item

Item type written to the wrapped asynchronous output.

fn is_buffered(&self) -> bool

Returns the wrapped output’s buffering capability.

Returns

Returns true when the wrapped output is buffered.

unsafe fn poll_write_unchecked( self: Pin<&mut Self>, cx: &mut Context<'_>, input: &[Self::Item], index: usize, count: usize, ) -> Poll<Result<usize>>

Forwards an unchecked asynchronous write to the pinned boxed output.

Parameters

• cx: Task context used to register a wake-up.
• input: Source item slice.
• index: Starting source index.
• count: Maximum number of items to write.

Returns

Returns a pending state or the wrapped output’s ready write result.

Errors

Returns an error reported by the wrapped output.

Safety

The range index..index + count must be valid for input.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Forwards an asynchronous flush to the pinned boxed output.

Parameters

• cx: Task context used to register a wake-up.

Returns

Returns a pending state or the wrapped output’s ready flush result.

Errors

Returns an error reported while flushing the wrapped output.

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, input: &[Self::Item], ) -> Poll<Result<usize>>

Polls one write from the full source slice.

fn write_async<'a>( &'a mut self, input: &'a [Self::Item], ) -> WriteFuture<'a, Self>

where Self: Sized + Unpin,

Creates a future that performs one asynchronous write operation.

fn write_fully_async<'a>( &'a mut self, input: &'a [Self::Item], ) -> WriteFullyFuture<'a, Self>

where Self: Sized + Unpin,

Creates a future that writes the entire source slice.

fn flush_async(&mut self) -> FlushFuture<'_, Self>

where Self: Sized + Unpin,

Creates a future that flushes internally buffered items.