Struct BlockParser

pub struct BlockParser { /* private fields */ }

Multithreaded parser for bitcoin::Block.

Examples

Call parse() to run a Fn(Block) -> T that returns a ParserIterator<T>. The Fn closure runs on multiple threads.

use bitcoin_block_parser::blocks::*;

let parser = BlockParser::new("/home/user/.bitcoin/blocks/").unwrap();
let iterator = parser.parse(|block| block.total_size() as u64);
println!("Total blockchain size: {}", iterator.sum::<u64>());

You can call block_range() to constrain the block range and ordered() to ensure the iterator returns blocks in height order:

use bitcoin_block_parser::blocks::*;

let parser = BlockParser::new("/home/user/.bitcoin/blocks/").unwrap();
let iterator = parser
    .block_range(100_000, 100_010)
    .parse(|block| block.block_hash())
    .ordered();

println!("In-order block hashes from 100,000 to 100,010:");
for block_hash in iterator {
    println!("{}", block_hash);
}

Implementations

impl BlockParser

pub fn new(blocks_dir: &str) -> Result<Self>

Creates a new parser given the blocks directory where the *.blk files are located.

• Returns an Err if unable to parse the blk files.
• You can specify the blocks directory when running bitcoind.

pub fn new_with_opts(blocks_dir: &str, options: ParserOptions) -> Result<Self>

Creates a parser with custom ParserOptions.

pub fn block_range(self, start_height: usize, end_height: usize) -> Self

Sets the inclusive range of block heights to parse.

• start_height - must be less than the total number of blocks, 0 will start at the genesis block.
• end_height - the height to end at, usize::MAX will stop at the last block available.

pub fn parse<T: Send + 'static>( &self, extract: impl Fn(Block) -> T + Clone + Send + 'static, ) -> ParserIterator<T>

Parse all bitcoin::Block into type T and return a ParserIterator<T>. Results will be in random order due to multithreading.

• extract - a closure that runs on multiple threads. For best performance perform as much computation and data reduction here as possible.

Trait Implementations

impl Clone for BlockParser

fn clone(&self) -> BlockParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockParser

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

Formats the value using the given formatter.