Publish autogenerated nightly docs

bitcoindevkit · Sep 30, 2024 · af3a8ad · af3a8ad
1 parent 1241773
commit af3a8ad
Show file tree

Hide file tree

Showing 218 changed files with 675 additions and 812 deletions.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/struct.BlockEvent.html
@@ -1,18 +1,18 @@
 <!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="A newly emitted block from `Emitter`."><title>BlockEvent in bdk_bitcoind_rpc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bdk_bitcoind_rpc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (78a775127 2024-05-11)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[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="../bdk_bitcoind_rpc/index.html">bdk_bitcoind_rpc</a><span class="version">0.15.0</span></h2></div><h2 class="location"><a href="#">BlockEvent</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.block">block</a></li><li><a href="#structfield.checkpoint">checkpoint</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.block_hash">block_hash</a></li><li><a href="#method.block_height">block_height</a></li><li><a href="#method.connected_to">connected_to</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-BlockEvent%3CB%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-BlockEvent%3CB%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-BlockEvent%3CB%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BlockEvent%3CB%3E">Send</a></li><li><a href="#impl-Sync-for-BlockEvent%3CB%3E">Sync</a></li><li><a href="#impl-Unpin-for-BlockEvent%3CB%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BlockEvent%3CB%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In crate bdk_bitcoind_rpc</a></h2></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"><h1>Struct <a href="index.html">bdk_bitcoind_rpc</a>::<wbr><a class="struct" href="#">BlockEvent</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/bdk_bitcoind_rpc/lib.rs.html#146-159">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct BlockEvent&lt;B&gt; {
     pub block: B,
-    pub checkpoint: <a class="struct" href="../bdk_core/checkpoint/struct.CheckPoint.html" title="struct bdk_core::checkpoint::CheckPoint">CheckPoint</a>,
+    pub checkpoint: CheckPoint,
 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A newly emitted block from <a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a>.</p>
 </div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.block" class="structfield section-header"><a href="#structfield.block" class="anchor field">§</a><code>block: B</code></span><div class="docblock"><p>Either a full [<code>Block</code>] or [<code>Header</code>] of the new block.</p>
-</div><span id="structfield.checkpoint" class="structfield section-header"><a href="#structfield.checkpoint" class="anchor field">§</a><code>checkpoint: <a class="struct" href="../bdk_core/checkpoint/struct.CheckPoint.html" title="struct bdk_core::checkpoint::CheckPoint">CheckPoint</a></code></span><div class="docblock"><p>The checkpoint of the new block.</p>
-<p>A <a href="../bdk_core/checkpoint/struct.CheckPoint.html" title="struct bdk_core::checkpoint::CheckPoint"><code>CheckPoint</code></a> is a node of a linked list of <a href="../bdk_core/block_id/struct.BlockId.html" title="struct bdk_core::block_id::BlockId"><code>BlockId</code></a>s. This checkpoint is linked to
-all <a href="../bdk_core/block_id/struct.BlockId.html" title="struct bdk_core::block_id::BlockId"><code>BlockId</code></a>s originally passed in <a href="struct.Emitter.html#method.new" title="associated function bdk_bitcoind_rpc::Emitter::new"><code>Emitter::new</code></a> as well as emitted blocks since then.
+</div><span id="structfield.checkpoint" class="structfield section-header"><a href="#structfield.checkpoint" class="anchor field">§</a><code>checkpoint: CheckPoint</code></span><div class="docblock"><p>The checkpoint of the new block.</p>
+<p>A [<code>CheckPoint</code>] is a node of a linked list of [<code>BlockId</code>]s. This checkpoint is linked to
+all [<code>BlockId</code>]s originally passed in <a href="struct.Emitter.html#method.new" title="associated function bdk_bitcoind_rpc::Emitter::new"><code>Emitter::new</code></a> as well as emitted blocks since then.
 These blocks are guaranteed to be of the same chain.</p>
 <p>This is important as BDK structures require block-to-apply to be connected with another
 block in the original chain.</p>
 </div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-BlockEvent%3CB%3E" class="impl"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#161-185">source</a><a href="#impl-BlockEvent%3CB%3E" class="anchor">§</a><h3 class="code-header">impl&lt;B&gt; <a class="struct" href="struct.BlockEvent.html" title="struct bdk_bitcoind_rpc::BlockEvent">BlockEvent</a>&lt;B&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.block_height" class="method"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#163-165">source</a><h4 class="code-header">pub fn <a href="#method.block_height" class="fn">block_height</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>The block height of this new block.</p>
 </div></details><details class="toggle method-toggle" open><summary><section id="method.block_hash" class="method"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#168-170">source</a><h4 class="code-header">pub fn <a href="#method.block_hash" class="fn">block_hash</a>(&amp;self) -&gt; BlockHash</h4></section></summary><div class="docblock"><p>The block hash of this new block.</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.connected_to" class="method"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#178-184">source</a><h4 class="code-header">pub fn <a href="#method.connected_to" class="fn">connected_to</a>(&amp;self) -&gt; <a class="struct" href="../bdk_core/block_id/struct.BlockId.html" title="struct bdk_core::block_id::BlockId">BlockId</a></h4></section></summary><div class="docblock"><p>The <a href="../bdk_core/block_id/struct.BlockId.html" title="struct bdk_core::block_id::BlockId"><code>BlockId</code></a> of a previous block that this block connects to.</p>
-<p>This either returns a <a href="../bdk_core/block_id/struct.BlockId.html" title="struct bdk_core::block_id::BlockId"><code>BlockId</code></a> of a previously emitted block or from the chain we started
+</div></details><details class="toggle method-toggle" open><summary><section id="method.connected_to" class="method"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#178-184">source</a><h4 class="code-header">pub fn <a href="#method.connected_to" class="fn">connected_to</a>(&amp;self) -&gt; BlockId</h4></section></summary><div class="docblock"><p>The [<code>BlockId</code>] of a previous block that this block connects to.</p>
+<p>This either returns a [<code>BlockId</code>] of a previously emitted block or from the chain we started
 with (passed in as <code>last_cp</code> in <a href="struct.Emitter.html#method.new" title="associated function bdk_bitcoind_rpc::Emitter::new"><code>Emitter::new</code></a>).</p>
 <p>This value is derived from <a href="struct.BlockEvent.html#structfield.checkpoint" title="field bdk_bitcoind_rpc::BlockEvent::checkpoint"><code>BlockEvent::checkpoint</code></a>.</p>
 </div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-BlockEvent%3CB%3E" class="impl"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#145">source</a><a href="#impl-Debug-for-BlockEvent%3CB%3E" class="anchor">§</a><h3 class="code-header">impl&lt;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BlockEvent.html" title="struct bdk_bitcoind_rpc::BlockEvent">BlockEvent</a>&lt;B&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/bdk_bitcoind_rpc/lib.rs.html#145">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-BlockEvent%3CB%3E" class="impl"><a href="#impl-Freeze-for-BlockEvent%3CB%3E" class="anchor">§</a><h3 class="code-header">impl&lt;B&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.BlockEvent.html" title="struct bdk_bitcoind_rpc::BlockEvent">BlockEvent</a>&lt;B&gt;<div class="where">where