Merge pull request #606 from romanz/fix-bip158-format

Fix bip158 example formatting
This commit is contained in:
Dr. Maxim Orlovsky 2021-06-06 20:11:22 +02:00 committed by GitHub
commit 73f1ed7d4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 18 deletions

View File

@ -23,13 +23,14 @@
//! The filter construction proposed is an alternative to Bloom filters, as used in BIP 37, //! 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. //! that minimizes filter size by using Golomb-Rice coding for compression.
//! //!
//! USE : //! ## Example
//! // create a block filter for a block (server side)
//! //!
//! ```ignore
//! fn get_script_for_coin(coin: &OutPoint) -> Result<Script, BlockFilterError> { //! fn get_script_for_coin(coin: &OutPoint) -> Result<Script, BlockFilterError> {
//! // get utxo ... //! // get utxo ...
//! } //! }
//! //!
//! // create a block filter for a block (server side)
//! let filter = BlockFilter::new_script_filter(&block, get_script_for_coin)?; //! let filter = BlockFilter::new_script_filter(&block, get_script_for_coin)?;
//! //!
//! // or create a filter from known raw data //! // or create a filter from known raw data
@ -41,7 +42,7 @@
//! if filter.match_any(&block_hash, &mut query.map(|s| s.as_bytes())) { //! if filter.match_any(&block_hash, &mut query.map(|s| s.as_bytes())) {
//! // get this block //! // get this block
//! } //! }
//! //! ```
//! //!
use std::{cmp, fmt, io}; use std::{cmp, fmt, io};