Skip to content

Commit f04bd3b

Browse files
author
github-actions
committed
Publish autogenerated nightly docs
1 parent d13ecfd commit f04bd3b

31 files changed

+102
-102
lines changed

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,8 +236,8 @@ <h5 id="errors-7"><a class="doc-anchor" href="#errors-7">§</a>Errors</h5>
236236
<p>This function will return an error if hardened derivation is attempted.</p>
237237
</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-Clone-for-Descriptor%3CPk%3E" class="impl"><a href="#impl-Clone-for-Descriptor%3CPk%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Pk&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;Pk&gt;<div class="where">where
238238
Pk: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + MiniscriptKey,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;Pk&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Descriptor%3CPk%3E" class="impl"><a href="#impl-Debug-for-Descriptor%3CPk%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Pk&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="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;Pk&gt;<div class="where">where
239-
Pk: MiniscriptKey,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</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><details class="toggle implementors-toggle" open><summary><section id="impl-DescriptorExt-for-Descriptor%3CDescriptorPublicKey%3E" class="impl"><a class="src rightside" href="../../src/bdk_chain/descriptor_ext.rs.html#26">Source</a><a href="#impl-DescriptorExt-for-Descriptor%3CDescriptorPublicKey%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../../bdk_chain/descriptor_ext/trait.DescriptorExt.html" title="trait bdk_chain::descriptor_ext::DescriptorExt">DescriptorExt</a> for <a class="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;<a class="enum" href="enum.DescriptorPublicKey.html" title="enum bdk_wallet::descriptor::DescriptorPublicKey">DescriptorPublicKey</a>&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.dust_value" class="method trait-impl"><a class="src rightside" href="../../src/bdk_chain/descriptor_ext.rs.html#27">Source</a><a href="#method.dust_value" class="anchor">§</a><h4 class="code-header">fn <a href="../../bdk_chain/descriptor_ext/trait.DescriptorExt.html#tymethod.dust_value" class="fn">dust_value</a>(&amp;self) -&gt; Amount</h4></section></summary><div class='docblock'>Returns the minimum [<code>Amount</code>] at which an output is broadcast-able.
240-
Panics if the descriptor wildcard is hardened.</div></details><details class="toggle method-toggle" open><summary><section id="method.descriptor_id" class="method trait-impl"><a class="src rightside" href="../../src/bdk_chain/descriptor_ext.rs.html#34">Source</a><a href="#method.descriptor_id" class="anchor">§</a><h4 class="code-header">fn <a href="../../bdk_chain/descriptor_ext/trait.DescriptorExt.html#tymethod.descriptor_id" class="fn">descriptor_id</a>(&amp;self) -&gt; <a class="struct" href="../../bdk_chain/descriptor_ext/struct.DescriptorId.html" title="struct bdk_chain::descriptor_ext::DescriptorId">DescriptorId</a></h4></section></summary><div class='docblock'>Returns the descriptor ID, calculated as the sha256 hash of the spk derived from the
239+
Pk: MiniscriptKey,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</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><details class="toggle implementors-toggle" open><summary><section id="impl-DescriptorExt-for-Descriptor%3CDescriptorPublicKey%3E" class="impl"><a href="#impl-DescriptorExt-for-Descriptor%3CDescriptorPublicKey%3E" class="anchor">§</a><h3 class="code-header">impl DescriptorExt for <a class="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;<a class="enum" href="enum.DescriptorPublicKey.html" title="enum bdk_wallet::descriptor::DescriptorPublicKey">DescriptorPublicKey</a>&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.dust_value" class="method trait-impl"><a href="#method.dust_value" class="anchor">§</a><h4 class="code-header">fn <a class="fn">dust_value</a>(&amp;self) -&gt; Amount</h4></section></summary><div class='docblock'>Returns the minimum [<code>Amount</code>] at which an output is broadcast-able.
240+
Panics if the descriptor wildcard is hardened.</div></details><details class="toggle method-toggle" open><summary><section id="method.descriptor_id" class="method trait-impl"><a href="#method.descriptor_id" class="anchor">§</a><h4 class="code-header">fn <a class="fn">descriptor_id</a>(&amp;self) -&gt; DescriptorId</h4></section></summary><div class='docblock'>Returns the descriptor ID, calculated as the sha256 hash of the spk derived from the
241241
descriptor at index 0.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deserialize%3C'de%3E-for-Descriptor%3CPk%3E" class="impl"><a href="#impl-Deserialize%3C'de%3E-for-Descriptor%3CPk%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'de, Pk&gt; <a class="trait" href="https://docs.rs/serde/1.0.217/serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt; for <a class="enum" href="enum.Descriptor.html" title="enum bdk_wallet::descriptor::Descriptor">Descriptor</a>&lt;Pk&gt;<div class="where">where
242242
Pk: FromStrKey,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deserialize" class="method trait-impl"><a href="#method.deserialize" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/serde/1.0.217/serde/de/trait.Deserialize.html#tymethod.deserialize" class="fn">deserialize</a>&lt;D&gt;(
243243
deserializer: D,

docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/enum.ApplyBlockError.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!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="An error that may occur when applying a block to `Wallet`."><title>ApplyBlockError in bdk_wallet - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-5d1d17d0.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bdk_wallet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (f3d1d47fd 2025-01-20)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.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 enum"><!--[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><a class="logo-container" href="../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../bdk_wallet/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../bdk_wallet/index.html">bdk_<wbr>wallet</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Apply<wbr>Block<wbr>Error</a></h2><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.CannotConnect" title="CannotConnect">CannotConnect</a></li><li><a href="#variant.UnexpectedConnectedToHash" title="UnexpectedConnectedToHash">UnexpectedConnectedToHash</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ApplyBlockError" title="Debug">Debug</a></li><li><a href="#impl-Display-for-ApplyBlockError" title="Display">Display</a></li><li><a href="#impl-Error-for-ApplyBlockError" title="Error">Error</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ApplyBlockError" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ApplyBlockError" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ApplyBlockError" title="Send">Send</a></li><li><a href="#impl-Sync-for-ApplyBlockError" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-ApplyBlockError" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ApplyBlockError" title="UnwindSafe">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" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-ToString-for-T" title="ToString">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li><li><a href="#impl-VZip%3CV%3E-for-T" title="VZip&#60;V&#62;">VZip&#60;V&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bdk_<wbr>wallet</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"><span class="rustdoc-breadcrumbs"><a href="index.html">bdk_wallet</a></span><h1>Enum <span class="enum">ApplyBlockError</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/bdk_wallet/wallet/mod.rs.html#249-259">Source</a> </span></div><pre class="rust item-decl"><code>pub enum ApplyBlockError {
2-
CannotConnect(<a class="struct" href="../bdk_chain/local_chain/struct.CannotConnectError.html" title="struct bdk_chain::local_chain::CannotConnectError">CannotConnectError</a>),
2+
CannotConnect(CannotConnectError),
33
UnexpectedConnectedToHash {
44
connected_to_hash: BlockHash,
55
expected_hash: BlockHash,
66
},
77
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An error that may occur when applying a block to <a href="struct.Wallet.html" title="struct bdk_wallet::Wallet"><code>Wallet</code></a>.</p>
8-
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.CannotConnect" class="variant"><a href="#variant.CannotConnect" class="anchor">§</a><h3 class="code-header">CannotConnect(<a class="struct" href="../bdk_chain/local_chain/struct.CannotConnectError.html" title="struct bdk_chain::local_chain::CannotConnectError">CannotConnectError</a>)</h3></section><div class="docblock"><p>Occurs when the update chain cannot connect with original chain.</p>
8+
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.CannotConnect" class="variant"><a href="#variant.CannotConnect" class="anchor">§</a><h3 class="code-header">CannotConnect(CannotConnectError)</h3></section><div class="docblock"><p>Occurs when the update chain cannot connect with original chain.</p>
99
</div><section id="variant.UnexpectedConnectedToHash" class="variant"><a href="#variant.UnexpectedConnectedToHash" class="anchor">§</a><h3 class="code-header">UnexpectedConnectedToHash</h3></section><div class="docblock"><p>Occurs when the <code>connected_to</code> hash does not match the hash derived from <code>block</code>.</p>
1010
</div><div class="sub-variant" id="variant.UnexpectedConnectedToHash.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.UnexpectedConnectedToHash.field.connected_to_hash" class="section-header"><a href="#variant.UnexpectedConnectedToHash.field.connected_to_hash" class="anchor field">§</a><code>connected_to_hash: BlockHash</code></span><div class="docblock"><p>Block hash of <code>connected_to</code>.</p>
1111
</div></div><div class="sub-variant-field"><span id="variant.UnexpectedConnectedToHash.field.expected_hash" class="section-header"><a href="#variant.UnexpectedConnectedToHash.field.expected_hash" class="anchor field">§</a><code>expected_hash: BlockHash</code></span><div class="docblock"><p>Expected block hash of <code>connected_to</code>, as derived from <code>block</code>.</p>

0 commit comments

Comments
 (0)