Struct FuturesOutput 

pub struct FuturesOutput<T> { /* private fields */ }

Adapts a futures-io AsyncWrite value to Qubit’s AsyncOutput.

Type Parameters

• T: Futures-io writer type.

Implementations

impl<T> FuturesOutput<T>

pub const fn new(inner: T) -> Self

Creates an adapter around a futures-io writer.

Parameters

• inner: Futures-io writer to adapt.

Returns

Returns a Qubit output adapter that owns inner.

pub const fn get_ref(&self) -> &T

Returns a shared reference to the wrapped writer.

Returns

Returns the wrapped futures-io writer.

pub const fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the wrapped writer.

Returns

Returns the wrapped futures-io writer with mutable access.

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

Projects a pinned adapter to its pinned wrapped writer.

Returns

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

pub fn into_inner(self) -> T

Consumes the adapter and returns the wrapped writer.

Returns

Returns the owned futures-io writer.

Trait Implementations

impl<T> AsyncClose for FuturesOutput<T>

where T: AsyncWrite,

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

Polls closing through the wrapped futures-io writer.

Parameters

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

Returns

Returns Poll::Pending while closing is incomplete, otherwise a ready success result.

Errors

Returns an I/O error reported by the wrapped writer. Invalid asynchronous error kinds are normalized to std::io::ErrorKind::InvalidData.

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

where Self: Sized + Unpin,

Creates a future that closes this output.

impl<T> AsyncOutput for FuturesOutput<T>

where T: AsyncWrite,

type Item = u8

Byte item accepted by a futures-io writer.

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

Polls an indexed write through the wrapped futures-io writer.

A zero-length request completes immediately without polling inner.

Parameters

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

Returns

Returns Poll::Pending when the writer is not ready. A ready result contains the number of bytes accepted.

Errors

Returns an I/O error reported by the wrapped writer. Invalid asynchronous error kinds are normalized to std::io::ErrorKind::InvalidData.

Panics

Panics in debug builds if the requested input range does not fit.

Safety

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

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

Polls flushing through the wrapped futures-io writer.

Parameters

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

Returns

Returns Poll::Pending while flushing is incomplete, otherwise a ready success result.

Errors

Returns an I/O error reported by the wrapped writer. Invalid asynchronous error kinds are normalized to std::io::ErrorKind::InvalidData.

fn is_buffered(&self) -> bool

Returns whether this output already buffers items internally.

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.