Struct FilterParser

pub struct FilterParser { /* private fields */ }

A parser that writes a probabilistic filter of unspent ShortOutPoint. See the module docs for example usage.

We use a ScalableCuckooFilter which is compact like a bloom filter, but allows us to remove elements and grow/shrink the filter as needed. We use this filter in UtxoParser to avoid caching UTXOs when tracking input amounts and labeling outputs as OutStatus::Spent or OutStatus::Unspent

Implementations

impl FilterParser

pub fn new() -> Self

Constructs a new filter parser

pub fn write(self, output: &str) -> Result<()>

Writes the filter to disk for use in another parser (see UtxoParser::new) You must call the FilterParser::parse function first.

Trait Implementations

impl BlockParser<(Vec<ShortOutPoint>, Vec<ShortOutPoint>)> for FilterParser

fn options() -> Options

In order to track UTXO amounts we must process blocks in-order

fn extract(&self, block: Block) -> Vec<(Vec<ShortOutPoint>, Vec<ShortOutPoint>)>

Extracts the data you need from the block.

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

Runs on batches of B to return the final results, blocks will be in-order if Options::order_output has been set.

fn parse(&self, headers: &[ParsedHeader]) -> Receiver<Result<B>>

Parse all the blocks represented by the headers.

fn parse_dir(&self, blocks: &str) -> Result<Receiver<Result<B>>>

Parse all the blocks located in the blocks directory

fn parse_map<C: Send + 'static>( &self, headers: &[ParsedHeader], map: fn(_: B) -> C, ) -> Receiver<Result<C>>

Parse the blocks and then perform the map function. Use when performing expensive post-processing for a large speed-up. The mapping will occur after BlockParser::batch, keeping the ordering.

fn parse_with_opts( &self, headers: &[ParsedHeader], opts: Options, ) -> Receiver<Result<B>>

Allows users to pass in custom Options in case they need to reduce memory usage or otherwise tune performance for their system. Users should call BlockParser::options to get the default options associated with the parser first.

fn parse_with_opts_map<C: Send + 'static>( &self, headers: &[ParsedHeader], opts: Options, map: fn(_: B) -> C, ) -> Receiver<Result<C>>

Pass in custom Options and a map function.

fn send_batch<C>( &self, tx_c: &Sender<Result<C>>, batch: Result<Vec<B>>, map: fn(_: B) -> C, )

Helper function for sending batch results in a channel

impl Clone for FilterParser

fn clone(&self) -> FilterParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for FilterParser

fn default() -> Self

Returns the “default value” for a type.