Struct AsyncCountingOutput 

pub struct AsyncCountingOutput<O> { /* private fields */ }

Asynchronous output that counts successfully accepted items.

Type Parameters

• O: Wrapped asynchronous output type.

Implementations

impl<O> AsyncCountingOutput<O>

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

Creates a counting asynchronous output.

Parameters

• inner: Asynchronous output to wrap.

Returns

Returns an output whose item count starts at zero.

pub const fn items_written(&self) -> u64

Returns the successfully accepted item count.

Returns

Returns a count that saturates at u64::MAX.

pub const fn inner(&self) -> &O

Returns a shared reference to the wrapped output.

Returns

Returns the wrapped asynchronous output.

pub fn inner_mut(&mut self) -> &mut O

Returns a mutable reference to the wrapped output.

Writes performed directly on the returned output are not included in this wrapper’s item count.

Returns

Returns the wrapped asynchronous output.

pub fn into_inner(self) -> O

Consumes this wrapper and returns the wrapped output.

Returns

Returns the asynchronous output.

impl<O> AsyncCountingOutput<O>

where O: AsyncOutput<Item = u8>,

pub const fn bytes_written(&self) -> u64

Returns the successfully accepted byte count.

Returns

Returns the same value as Self::items_written.

Trait Implementations

impl<O> AsyncClose for AsyncCountingOutput<O>

where O: AsyncClose,

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

Polls closing through the wrapped output.

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 error reported by the wrapped output. Invalid asynchronous error kinds are normalized to io::ErrorKind::InvalidData.

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

where Self: Sized + Unpin,

Creates a future that closes this output.

impl<O> AsyncOutput for AsyncCountingOutput<O>

where O: AsyncOutput,

type Item = <O as AsyncOutput>::Item

Item type counted after successful writes.

fn is_buffered(&self) -> bool

Preserves the wrapped output’s buffering declaration.

Returns

Returns the wrapped output’s buffering declaration.

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

Polls a write and counts only a successful ready result.

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 Poll::Pending when the output is not ready. A ready success contains the number of items accepted and added to the saturating count.

Errors

Returns an I/O error reported by the wrapped output without changing the count.

Safety

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

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

Polls the wrapped output’s flush operation.

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 error reported by the wrapped output. Invalid asynchronous error kinds are normalized to io::ErrorKind::InvalidData.

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.

impl<O: Debug> Debug for AsyncCountingOutput<O>

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

Formats the value using the given formatter.