Struct MerkleTreeWriter

pub struct MerkleTreeWriter<W> { /* private fields */ }

A MerkleTreeWriter wraps a MerkleTreeBuilder and another type that implements std::io::Write.

MerkleTreeWriters can be used to compute a MerkleTree while streaming data from one location to another. To simply compute a MerkleTree without chaining writes to a separate Writer, see MerkleTreeBuilder.

Examples

let data = vec![0xff; 8192];
let mut written = Vec::new();
{
    let mut writer = MerkleTreeWriter::new(&mut written);
    writer.write_all(&data)?;
    assert_eq!(
        writer.finish().root(),
        "68d131bc271f9c192d4f6dcd8fe61bef90004856da19d0f2f514a7f4098b0737"
            .parse()
            .unwrap()
    );
}
assert_eq!(written, data);

Implementations

impl<W: Write> MerkleTreeWriter<W>

pub fn new(inner: W) -> Self

Creates a new MerkleTreeWriter

pub fn finish(self) -> MerkleTree

Finalizes all levels of the merkle tree, converting this MerkleTreeWriter instance into a MerkleTree.

Trait Implementations

impl<W: Write> Write for MerkleTreeWriter<W>

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, fmt: 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.