Trait bitcoin_block_parser::blocks::BlockParser

source ·

pub trait BlockParser<B: Send + 'static, C: Send + 'static>:
    Clone
    + Send
    + 'static {
    // Required methods
    fn extract(&self, block: Block) -> Option<B>;
    fn batch(&self, items: Vec<B>) -> Vec<C>;

    // Provided methods
    fn options() -> Options { ... }
    fn parse(&self, headers: &[ParsedHeader]) -> Receiver<Result<C>> { ... }
    fn parse_ordered(&self, headers: &[ParsedHeader]) -> Receiver<Result<C>> { ... }
    fn parse_with_opts(
        &self,
        headers: &[ParsedHeader],
        opts: Options,
    ) -> Receiver<Result<C>> { ... }
    fn send_batch(&self, tx_c: &Sender<Result<C>>, batch: Result<Vec<B>>) { ... }
}

Expand description

Implement this trait to create a custom Block parser.

Required Methods§

source

fn extract(&self, block: Block) -> Option<B>

Extracts the data you need from the block.

If you can keep B small or return None you will gain memory/speed performance. Always runs on blocks out-of-order using multiple threads so put compute-heavy code in here.

source

fn batch(&self, items: Vec<B>) -> Vec<C>

Runs on batches of the BlockParser::extract to return the final results.

We batch to reduce contention in the case the parser needs to modify shared state by locking an Arc<Mutex<_>>. Use Options::batch_size if you need to tune the number of the items.