29 lines
11 KiB
HTML
29 lines
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This trait provides sequential access to raw blockchain data via a callback-oriented API."><title>BlockSource in zcash_client_backend::data_api::chain - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-20739d33.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="zcash_client_backend" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0-nightly (74509131e 2025-04-29)" data-channel="nightly" data-search-js="search-f7877310.js" data-settings-js="settings-5514c975.js" ><script src="../../../static.files/storage-4e99c027.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../zcash_client_backend/index.html">zcash_<wbr>client_<wbr>backend</a><span class="version">0.18.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Block<wbr>Source</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.with_blocks" title="with_blocks">with_blocks</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In zcash_<wbr>client_<wbr>backend::<wbr>data_<wbr>api::<wbr>chain</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">zcash_client_backend</a>::<wbr><a href="../index.html">data_api</a>::<wbr><a href="index.html">chain</a></div><h1>Trait <span class="trait">BlockSource</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/zcash_client_backend/data_api/chain.rs.html#213-232">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BlockSource {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.with_blocks" class="fn">with_blocks</a><F, WalletErrT>(
|
|
&self,
|
|
from_height: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><BlockHeight>,
|
|
limit: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>,
|
|
with_block: F,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.Error.html" title="enum zcash_client_backend::data_api::chain::error::Error">Error</a><WalletErrT, Self::<a class="associatedtype" href="trait.BlockSource.html#associatedtype.Error" title="type zcash_client_backend::data_api::chain::BlockSource::Error">Error</a>>>
|
|
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../proto/compact_formats/struct.CompactBlock.html" title="struct zcash_client_backend::proto::compact_formats::CompactBlock">CompactBlock</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.Error.html" title="enum zcash_client_backend::data_api::chain::error::Error">Error</a><WalletErrT, Self::<a class="associatedtype" href="trait.BlockSource.html#associatedtype.Error" title="type zcash_client_backend::data_api::chain::BlockSource::Error">Error</a>>></span>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This trait provides sequential access to raw blockchain data via a callback-oriented
|
|
API.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../../src/zcash_client_backend/data_api/chain.rs.html#214">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.with_blocks" class="method"><a class="src rightside" href="../../../src/zcash_client_backend/data_api/chain.rs.html#224-231">Source</a><h4 class="code-header">fn <a href="#tymethod.with_blocks" class="fn">with_blocks</a><F, WalletErrT>(
|
|
&self,
|
|
from_height: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><BlockHeight>,
|
|
limit: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>,
|
|
with_block: F,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.Error.html" title="enum zcash_client_backend::data_api::chain::error::Error">Error</a><WalletErrT, Self::<a class="associatedtype" href="trait.BlockSource.html#associatedtype.Error" title="type zcash_client_backend::data_api::chain::BlockSource::Error">Error</a>>><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../proto/compact_formats/struct.CompactBlock.html" title="struct zcash_client_backend::proto::compact_formats::CompactBlock">CompactBlock</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.Error.html" title="enum zcash_client_backend::data_api::chain::error::Error">Error</a><WalletErrT, Self::<a class="associatedtype" href="trait.BlockSource.html#associatedtype.Error" title="type zcash_client_backend::data_api::chain::BlockSource::Error">Error</a>>>,</div></h4></section></summary><div class="docblock"><p>Scan the specified <code>limit</code> number of blocks from the blockchain, starting at
|
|
<code>from_height</code>, applying the provided callback to each block. If <code>from_height</code>
|
|
is <code>None</code> then scanning will begin at the first available block.</p>
|
|
<ul>
|
|
<li><code>WalletErrT</code>: the types of errors produced by the wallet operations performed
|
|
as part of processing each row.</li>
|
|
<li><code>NoteRefT</code>: the type of note identifiers in the wallet data store, for use in
|
|
reporting errors related to specific notes.</li>
|
|
</ul>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-BlockSource-for-MockBlockSource" class="impl"><a class="src rightside" href="../../../src/zcash_client_backend/data_api/chain.rs.html#710-724">Source</a><a href="#impl-BlockSource-for-MockBlockSource" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.BlockSource.html" title="trait zcash_client_backend::data_api::chain::BlockSource">BlockSource</a> for <a class="struct" href="testing/struct.MockBlockSource.html" title="struct zcash_client_backend::data_api::chain::testing::MockBlockSource">MockBlockSource</a></h3><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>test-dependencies</code></strong> only.</div></span></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/zcash_client_backend/data_api/chain.rs.html#711">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></div></details></div><script src="../../../trait.impl/zcash_client_backend/data_api/chain/trait.BlockSource.js" async></script></section></div></main></body></html> |