BlockParser

Struct BlockParser 

Source
pub struct BlockParser { /* private fields */ }
Expand description

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 start_height() 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
    .start_height(100_000)
    .end_height(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§

Source§

impl BlockParser

Source

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

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

Source

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

Creates a parser with custom ParserOptions.

Source

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

Sets the inclusive start of block heights to parse.

  • start_height - must be less than the total number of blocks, 0 will start at the genesis block.
Source

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

Sets the inclusive end of block heights to parse.

  • end_height - the height to end at, usize::MAX will stop at the last block available.
Source

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§

Source§

impl Clone for BlockParser

Source§

fn clone(&self) -> BlockParser

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BlockParser

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V