Skip to content

Commit

Permalink
Publish autogenerated nightly docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 22, 2024
1 parent c5657be commit 3d27067
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/keychain/struct.ChangeSet.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!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="Represents updates to the derivation index of a `KeychainTxOutIndex`. It maps each keychain `K` to its last revealed index."><meta name="keywords" content="rust, rustlang, rust-lang, ChangeSet"><title>ChangeSet in bdk_chain::keychain - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-64f7dca12162a801.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-94f39d4346842c1e.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a211dbb005fb8161.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button><a class="sidebar-logo" href="../../bdk_chain/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../bdk_chain/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">ChangeSet</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Tuple Fields</a></h3><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_inner">as_inner</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Append-for-ChangeSet%3CK%3E">Append</a></li><li><a href="#impl-AsRef%3CBTreeMap%3CK%2C%20u32%2C%20Global%3E%3E-for-ChangeSet%3CK%3E">AsRef&lt;BTreeMap&lt;K, u32, Global&gt;&gt;</a></li><li><a href="#impl-Clone-for-ChangeSet%3CK%3E">Clone</a></li><li><a href="#impl-Debug-for-ChangeSet%3CK%3E">Debug</a></li><li><a href="#impl-Default-for-ChangeSet%3CK%3E">Default</a></li><li><a href="#impl-Deserialize%3C%27de%3E-for-ChangeSet%3CK%3E">Deserialize&lt;&#39;de&gt;</a></li><li><a href="#impl-From%3CChangeSet%3CK%3E%3E-for-ChangeSet%3CA%2C%20ChangeSet%3CK%3E%3E">From&lt;ChangeSet&lt;K&gt;&gt;</a></li><li><a href="#impl-PartialEq%3CChangeSet%3CK%3E%3E-for-ChangeSet%3CK%3E">PartialEq&lt;ChangeSet&lt;K&gt;&gt;</a></li><li><a href="#impl-Serialize-for-ChangeSet%3CK%3E">Serialize</a></li><li><a href="#impl-StructuralPartialEq-for-ChangeSet%3CK%3E">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ChangeSet%3CK%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ChangeSet%3CK%3E">Send</a></li><li><a href="#impl-Sync-for-ChangeSet%3CK%3E">Sync</a></li><li><a href="#impl-Unpin-for-ChangeSet%3CK%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ChangeSet%3CK%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ChangeSet%3CK%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ChangeSet%3CK%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ChangeSet%3CK%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-DeserializeOwned-for-ChangeSet%3CK%3E">DeserializeOwned</a></li><li><a href="#impl-From%3CT%3E-for-ChangeSet%3CK%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-ChangeSet%3CK%3E">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-ChangeSet%3CK%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ChangeSet%3CK%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-ChangeSet%3CK%3E">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-ChangeSet%3CK%3E">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In bdk_chain::keychain</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">bdk_chain</a>::<wbr><a href="index.html">keychain</a>::<wbr><a class="struct" href="#">ChangeSet</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/bdk_chain/keychain.rs.html#41">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ChangeSet&lt;K&gt;(pub <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/btree/map/struct.BTreeMap.html" title="struct alloc::collections::btree::map::BTreeMap">BTreeMap</a>&lt;K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents updates to the derivation index of a <a href="struct.KeychainTxOutIndex.html"><code>KeychainTxOutIndex</code></a>.
It maps each keychain <code>K</code> to its last revealed index.</p>
<p>It can be applied to <a href="struct.KeychainTxOutIndex.html"><code>KeychainTxOutIndex</code></a> with <a href="struct.KeychainTxOutIndex.html#method.apply_changeset"><code>apply_changeset</code></a>. <a href="struct.ChangeSet.html" title="ChangeSet">`ChangeSet</a> are
<p>It can be applied to <a href="struct.KeychainTxOutIndex.html"><code>KeychainTxOutIndex</code></a> with <a href="struct.KeychainTxOutIndex.html#method.apply_changeset"><code>apply_changeset</code></a>. <a href="struct.ChangeSet.html" title="ChangeSet"><code>ChangeSet</code></a>s are
monotone in that they will never decrease the revealed derivation index.</p>
</div></details><h2 id="fields" class="fields small-section-header">Tuple Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.0" class="structfield small-section-header"><a href="#structfield.0" class="anchor field">§</a><code>0: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/btree/map/struct.BTreeMap.html" title="struct alloc::collections::btree::map::BTreeMap">BTreeMap</a>&lt;K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;</code></span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ChangeSet%3CK%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/keychain.rs.html#43-48">source</a><a href="#impl-ChangeSet%3CK%3E" class="anchor">§</a><h3 class="code-header">impl&lt;K&gt; <a class="struct" href="struct.ChangeSet.html" title="struct bdk_chain::keychain::ChangeSet">ChangeSet</a>&lt;K&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/keychain.rs.html#45-47">source</a><h4 class="code-header">pub fn <a href="#method.as_inner" class="fn">as_inner</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/btree/map/struct.BTreeMap.html" title="struct alloc::collections::btree::map::BTreeMap">BTreeMap</a>&lt;K, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;</h4></section></summary><div class="docblock"><p>Get the inner map of the keychain to its new derivation index.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Append-for-ChangeSet%3CK%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/keychain.rs.html#50-70">source</a><a href="#impl-Append-for-ChangeSet%3CK%3E" class="anchor">§</a><h3 class="code-header">impl&lt;K:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>&gt; <a class="trait" href="../trait.Append.html" title="trait bdk_chain::Append">Append</a> for <a class="struct" href="struct.ChangeSet.html" title="struct bdk_chain::keychain::ChangeSet">ChangeSet</a>&lt;K&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.append" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/keychain.rs.html#55-64">source</a><a href="#method.append" class="anchor">§</a><h4 class="code-header">fn <a href="../trait.Append.html#tymethod.append" class="fn">append</a>(&amp;mut self, other: Self)</h4></section></summary><div class="docblock"><p>Append another <a href="struct.ChangeSet.html" title="ChangeSet"><code>ChangeSet</code></a> into self.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Only insert TxOuts you trust the values for!</p>
<p>Note <code>tx</code> does not have to be in the graph for this to work.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.outspends" class="method has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/tx_graph.rs.html#342-344">source</a><h4 class="code-header">pub fn <a href="#method.outspends" class="fn">outspends</a>(&amp;self, outpoint: OutPoint) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/set/struct.HashSet.html" title="struct std::collections::hash::set::HashSet">HashSet</a>&lt;Txid&gt;</h4></section></summary><div class="docblock"><p>The transactions spending from this output.</p>
<p><code>TxGraph</code> allows conflicting transactions within the graph. Obviously the transactions in
<p><a href="struct.TxGraph.html" title="TxGraph"><code>TxGraph</code></a> allows conflicting transactions within the graph. Obviously the transactions in
the returned set will never be in the same active-chain.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.tx_spends" class="method has-srclink"><a class="srclink rightside" href="../../src/bdk_chain/tx_graph.rs.html#352-364">source</a><h4 class="code-header">pub fn <a href="#method.tx_spends" class="fn">tx_spends</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;txid: Txid<br>) -&gt; impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="trait core::iter::traits::double_ended::DoubleEndedIterator">DoubleEndedIterator</a>&lt;Item = (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/collections/hash/set/struct.HashSet.html" title="struct std::collections::hash::set::HashSet">HashSet</a>&lt;Txid&gt;)&gt; + '_</h4></section></summary><div class="docblock"><p>Iterates over the transactions spending from <code>txid</code>.</p>
<p>The iterator item is a union of <code>(vout, txid-set)</code> where:</p>
Expand Down
Loading

0 comments on commit 3d27067

Please sign in to comment.