Struct count_write::CountWrite

pub struct CountWrite<W> { /* fields omitted */ }

A wrapper for std::io::Write (and other optional Write implementations) that counts the total number of bytes written successfully.

use std::io::{BufWriter, Write};

use count_write::CountWrite;

let vec = vec![]; // note that Vec<u8> : Write
let cw = CountWrite::from(vec);
let mut bw = BufWriter::new(cw);
write!(bw, "abc")?;
assert_eq!(bw.into_inner()?.count(), 3);

If the inner writer does not successfully write all bytes, only the successfully written bytes are counted. (This does not affect users who always use write_all, write!, etc.)

use std::io::{Result, Write};

use count_write::CountWrite;;

/// A dummy struct that only accepts half of the input into a Vec.
struct OnlyHalf;

impl Write for OnlyHalf {
    fn write(&mut self, buf: &[u8]) -> Result<usize> {
    dbg!(buf);
        Ok((buf.len() + 1) / 2)
    }

    fn flush(&mut self) -> Result<()> { Ok(()) }
}

let mut cw = CountWrite::from(OnlyHalf);
write!(cw, "abc")?; // Here, we keep retrying writing into the writer
assert_eq!(cw.count(), 3);

let mut cw = CountWrite::from(OnlyHalf);
cw.write(b"abc")?; // Here, we only write to the writer once and do not retry
assert_eq!(cw.count(), 2);

Methods

impl<W> CountWrite<W>

pub fn count(&self) -> u64

Returns the number of bytes successfull written so far

pub fn into_inner(self) -> W

Extracts the inner writer, discarding this wrapper

Trait Implementations

impl<W> From<W> for CountWrite<W>

fn from(inner: W) -> Self

Performs the conversion.

impl<W: Write> Write for CountWrite<W>

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

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

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

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

Attempts to write an entire buffer 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 Self

Creates a "by reference" adaptor for this instance of Write.

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

Wrapper for futures_io::AsyncWrite, used in the futures-preview family

Only available with the "futures" feature

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

Attempt to write bytes from buf into the object.

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

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<(), Error>>

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> AsyncWrite for CountWrite<W>

Wrapper for tokio_io::AsyncWrite, used in the tokio family

Only available with the "tokio" feature

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

Attempt to write bytes from buf into the object.

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

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

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

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

fn poll_write_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: Buf, 

Write a Buf into this value, returning how many bytes were written.