Struct countio::Counter

pub struct Counter<D> { /* private fields */ }

The Counter<D> struct adds byte counting to any reader or writer.

Implementations

impl<D> Counter<D>

pub fn new(inner: D) -> Self

Creates a new Counter<D> with zero read/written bytes.

pub fn with_bytes(reader_bytes: usize, writer_bytes: usize, inner: D) -> Self

Creates a new Counter<D> with the specified read/written bytes.

pub fn total_bytes(&self) -> usize

Returns the sum of read and written bytes by the underlying reader/writer.

pub fn reader_bytes(&self) -> usize

Returns the count of read bytes by the underlying reader.

pub fn writer_bytes(&self) -> usize

Returns the count of written bytes by the underlying writer.

pub fn into_inner(self) -> D

Consumes Counter<D> returning the underlying reader/writer.

pub fn get_ref(&self) -> &D

Gets a reference to the underlying reader/writer.

pub fn get_mut(&mut self) -> &mut D

Gets a mutable reference to the underlying reader/writer.

Trait Implementations

impl<R: AsyncRead + Unpin> AsyncRead for Counter<R>

fn poll_read( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &mut ReadBuf<'_> ) -> Poll<IoResult<()>>

Attempts to read from the AsyncRead into buf.

impl<R: AsyncRead + Unpin> AsyncRead for Counter<R>

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

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<D: AsyncSeek + Unpin> AsyncSeek for Counter<D>

fn start_seek(self: Pin<&mut Self>, position: SeekFrom) -> IoResult<()>

Attempts to seek to an offset, in bytes, in a stream.

fn poll_complete( self: Pin<&mut Self>, ctx: &mut Context<'_> ) -> Poll<IoResult<u64>>

Waits for a seek operation to complete.

impl<D: AsyncSeek + Unpin> AsyncSeek for Counter<D>

fn poll_seek( self: Pin<&mut Self>, ctx: &mut Context<'_>, pos: SeekFrom ) -> Poll<IoResult<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<W: AsyncWrite + Unpin> AsyncWrite for Counter<W>

fn poll_write( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &[u8] ) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<W: AsyncWrite + Unpin> AsyncWrite for Counter<W>

fn poll_write( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &[u8] ) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, ctx: &mut Context<'_> ) -> Poll<IoResult<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<D: Debug> Debug for Counter<D>

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

Formats the value using the given formatter.

impl<D> From<D> for Counter<D>

fn from(inner: D) -> Self

Converts to this type from the input type.

impl<R: Read> Read for Counter<R>

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

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, Global>) -> Result<usize, Error>

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

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

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

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

Read 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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere 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<D: Seek> Seek for Counter<D>

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

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.

impl<W: Write> Write for Counter<W>

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

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

fn flush(&mut self) -> IoResult<()>

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

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

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

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 Selfwhere Self: Sized,

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