From 60e51ada360c59d517f0f670fe3f1742c8e492b9 Mon Sep 17 00:00:00 2001 From: Roman Zeyde Date: Wed, 17 Feb 2021 22:35:13 +0200 Subject: [PATCH] Fix bip158 example formatting --- src/util/bip158.rs | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/src/util/bip158.rs b/src/util/bip158.rs index 5156dd1014..06f23125ae 100644 --- a/src/util/bip158.rs +++ b/src/util/bip158.rs @@ -23,26 +23,27 @@ //! The filter construction proposed is an alternative to Bloom filters, as used in BIP 37, //! that minimizes filter size by using Golomb-Rice coding for compression. //! -//! USE : -//! // create a block filter for a block (server side) -//! -//! fn get_script_for_coin (coin: &OutPoint) -> Result { -//! // get utxo ... -//! } -//! -//! let filter = BlockFilter::new_script_filter (&block, get_script_for_coin)?; -//! -//! // or create a filter from known raw data -//! let filter = BlockFilter::new(content); -//! -//! // read and evaluate a filter -//! -//! let query: Iterator = // .. some scripts you care about -//! if filter.match_any (&block_hash, &mut query.map(|s| s.as_bytes())) { -//! // get this block -//! } +//! ## Example //! +//! ```ignore +//! fn get_script_for_coin(coin: &OutPoint) -> Result { +//! // get utxo ... +//! } +//! +//! // create a block filter for a block (server side) +//! let filter = BlockFilter::new_script_filter(&block, get_script_for_coin)?; //! +//! // or create a filter from known raw data +//! let filter = BlockFilter::new(content); +//! +//! // read and evaluate a filter +//! +//! let query: Iterator = // .. some scripts you care about +//! if filter.match_any(&block_hash, &mut query.map(|s| s.as_bytes())) { +//! // get this block +//! } +//! ``` +//! use std::{cmp, fmt, io}; use std::collections::HashSet;