Struct Progress 

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

A progress tracker that extends Counter with percentage completion tracking.

Progress<D> wraps a Counter<D> and adds tracking for expected total bytes and derived metrics useful for progress reporting. Supports separate tracking for read and write operations.

Examples

use countio::Progress;
use std::io::Write;

let mut progress = Progress::with_expected_writer_bytes(Vec::new(), 1024);
progress.write_all(b"Hello").unwrap();

assert_eq!(progress.total_bytes(), 5);
assert_eq!(progress.expected_writer_bytes(), Some(1024));
assert!(progress.writer_percentage().unwrap() < 1.0);

Implementations

impl<D> Progress<D>

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

Creates a new Progress<D> with unknown expected sizes.

Examples

use countio::Progress;

let progress = Progress::new(Vec::<u8>::new());
assert_eq!(progress.expected_reader_bytes(), None);
assert_eq!(progress.expected_writer_bytes(), None);

pub const fn with_expected_reader_bytes(inner: D, expected: usize) -> Self

Creates a new Progress<D> with a known expected read size.

Examples

use countio::Progress;

let progress = Progress::with_expected_reader_bytes(&b"hello"[..], 5);
assert_eq!(progress.expected_reader_bytes(), Some(5));
assert_eq!(progress.expected_writer_bytes(), None);

pub const fn with_expected_writer_bytes(inner: D, expected: usize) -> Self

Creates a new Progress<D> with a known expected write size.

Examples

use countio::Progress;

let progress = Progress::with_expected_writer_bytes(Vec::<u8>::new(), 1024);
assert_eq!(progress.expected_reader_bytes(), None);
assert_eq!(progress.expected_writer_bytes(), Some(1024));

pub const fn with_expected_bytes( inner: D, expected_reader_bytes: usize, expected_writer_bytes: usize, ) -> Self

Creates a new Progress<D> with known expected read and write sizes.

Examples

use countio::Progress;
use std::io::Cursor;

let cursor = Cursor::new(vec![0u8; 100]);
let progress = Progress::with_expected_bytes(cursor, 100, 50);
assert_eq!(progress.expected_reader_bytes(), Some(100));
assert_eq!(progress.expected_writer_bytes(), Some(50));

pub const fn total_bytes(&self) -> u128

Returns the total number of bytes processed (read + written).

pub const fn reader_bytes(&self) -> usize

Returns the number of bytes read.

pub const fn writer_bytes(&self) -> usize

Returns the number of bytes written.

pub const fn expected_reader_bytes(&self) -> Option<usize>

Returns the expected number of bytes to read, if known.

pub const fn expected_writer_bytes(&self) -> Option<usize>

Returns the expected number of bytes to write, if known.

pub const fn set_expected_reader_bytes(&mut self, expected: Option<usize>)

Sets the expected number of bytes to read.

pub const fn set_expected_writer_bytes(&mut self, expected: Option<usize>)

Sets the expected number of bytes to write.

pub fn reader_percentage(&self) -> Option<f64>

Returns the read completion percentage (0.0 to 1.0) if expected read size is known.

Examples

use countio::Progress;
use std::io::Read;

let data = b"Hello, World!";
let mut progress = Progress::with_expected_reader_bytes(&data[..], 13);
let mut buf = [0u8; 5];
progress.read(&mut buf).unwrap();

assert!((progress.reader_percentage().unwrap() - 0.3846).abs() < 0.001);

pub fn writer_percentage(&self) -> Option<f64>

Returns the write completion percentage (0.0 to 1.0) if expected write size is known.

Examples

use countio::Progress;
use std::io::Write;

let mut progress = Progress::with_expected_writer_bytes(Vec::new(), 100);
progress.write_all(b"Hello").unwrap();

assert_eq!(progress.writer_percentage(), Some(0.05));

pub fn into_inner(self) -> D

Consumes the Progress<D> and returns the underlying I/O object.

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

Gets a reference to the underlying I/O object.

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

Gets a mutable reference to the underlying I/O object.

pub const fn reset(&mut self)

Resets the byte counters to zero without affecting the underlying I/O object or the expected totals.

Examples

use std::io::Write;
use countio::Progress;

let mut progress = Progress::with_expected_writer_bytes(Vec::new(), 100);
progress.write_all(b"Hello").unwrap();
assert_eq!(progress.writer_bytes(), 5);
assert_eq!(progress.writer_percentage(), Some(0.05));

progress.reset();
assert_eq!(progress.writer_bytes(), 0);
assert_eq!(progress.writer_percentage(), Some(0.0));
assert_eq!(progress.expected_writer_bytes(), Some(100)); // Expected preserved

Trait Implementations

impl<R: AsyncBufRead + Unpin> AsyncBufRead for Progress<R>

Available on crate feature futures only.

fn poll_fill_buf( self: Pin<&mut Self>, ctx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncBufRead + Unpin> AsyncBufRead for Progress<R>

Available on crate feature tokio only.

fn poll_fill_buf( self: Pin<&mut Self>, ctx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

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

Available on crate feature futures only.

fn poll_read( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<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<R: AsyncRead + Unpin> AsyncRead for Progress<R>

Available on crate feature tokio only.

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

Attempts to read from the AsyncRead into buf.

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

Available on crate feature futures only.

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

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

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

Available on crate feature tokio only.

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

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

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

Waits for a seek operation to complete.

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

Available on crate feature futures only.

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

Attempt to write bytes from buf into the object.

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

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

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

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 Progress<W>

Available on crate feature tokio only.

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

Attempt to write bytes from buf into the object.

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

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

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

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<R: BufRead> BufRead for Progress<R>

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Checks if there is any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<D: Clone> Clone for Progress<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug> Debug for Progress<D>

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

Formats the value using the given formatter.

impl<D: Default> Default for Progress<D>

fn default() -> Self

Returns the “default value” for a type.

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

fn from(counter: Counter<D>) -> Self

Converts to this type from the input type.

impl<R: Read> Read for Progress<R>

Available on crate feature std only.

fn read(&mut self, buf: &mut [u8]) -> Result<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>) -> Result<usize, Error>

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

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

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

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

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

impl<D: Seek> Seek for Progress<D>

Available on crate feature std only.

fn seek(&mut self, pos: SeekFrom) -> Result<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.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<W: Write> Write for Progress<W>

Available on crate feature std only.

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

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

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

Flushes 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, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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