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 21, 2025
1 parent eb7c35c commit f077dc8
Show file tree
Hide file tree
Showing 1,764 changed files with 2,653 additions and 2,565 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/all.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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-c579a84d.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.86.0-nightly (419b3e2d3 2025-01-15)" data-channel="nightly" data-search-js="search-1429c0ba.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.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 mod sys"><!--[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_<wbr>bitcoind_<wbr>rpc</a><span class="version">0.17.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.BlockEvent.html">BlockEvent</a></li><li><a href="struct.Emitter.html">Emitter</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.BitcoindRpcErrorExt.html">BitcoindRpcErrorExt</a></li></ul></section></div></main></body></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="List of all items in this crate"><title>List of all items in this crate</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_bitcoind_rpc" 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="../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 mod sys"><!--[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_<wbr>bitcoind_<wbr>rpc</a><span class="version">0.17.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.BlockEvent.html">BlockEvent</a></li><li><a href="struct.Emitter.html">Emitter</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="trait.BitcoindRpcErrorExt.html">BitcoindRpcErrorExt</a></li></ul></section></div></main></body></html>
4 changes: 2 additions & 2 deletions docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_bitcoind_rpc/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!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 crate is used for emitting blockchain data from the `bitcoind` RPC interface. It does not use the wallet RPC API, so this crate can be used with wallet-disabled Bitcoin Core nodes."><title>bdk_bitcoind_rpc - 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-c579a84d.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.86.0-nightly (419b3e2d3 2025-01-15)" data-channel="nightly" data-search-js="search-1429c0ba.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.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 mod crate"><!--[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_<wbr>bitcoind_<wbr>rpc</a><span class="version">0.17.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>bdk_bitcoind_rpc</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_bitcoind_rpc/lib.rs.html#1-328">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate is used for emitting blockchain data from the <code>bitcoind</code> RPC interface. It does not
<!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 crate is used for emitting blockchain data from the `bitcoind` RPC interface. It does not use the wallet RPC API, so this crate can be used with wallet-disabled Bitcoin Core nodes."><title>bdk_bitcoind_rpc - 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_bitcoind_rpc" 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="../crates.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 mod crate"><!--[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_<wbr>bitcoind_<wbr>rpc</a><span class="version">0.17.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>bdk_bitcoind_rpc</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_bitcoind_rpc/lib.rs.html#1-328">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate is used for emitting blockchain data from the <code>bitcoind</code> RPC interface. It does not
use the wallet RPC API, so this crate can be used with wallet-disabled Bitcoin Core nodes.</p>
<p><a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a> is the main structure which sources blockchain data from [<code>bitcoincore_rpc::Client</code>].</p>
<p>To only get block updates (exclude mempool transactions), the caller can use
<a href="struct.Emitter.html#method.next_block" title="method bdk_bitcoind_rpc::Emitter::next_block"><code>Emitter::next_block</code></a> or/and <a href="struct.Emitter.html#method.next_header" title="method bdk_bitcoind_rpc::Emitter::next_header"><code>Emitter::next_header</code></a> until it returns <code>Ok(None)</code> (which means
the chain tip is reached). A separate method, <a href="struct.Emitter.html#method.mempool" title="method bdk_bitcoind_rpc::Emitter::mempool"><code>Emitter::mempool</code></a> can be used to emit the whole
mempool.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.bitcoincore_rpc"><code>pub use bitcoincore_rpc;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BlockEvent.html" title="struct bdk_bitcoind_rpc::BlockEvent">Block<wbr>Event</a></div><div class="desc docblock-short">A newly emitted block from <a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter">Emitter</a></div><div class="desc docblock-short">The <a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a> is used to emit data sourced from [<code>bitcoincore_rpc::Client</code>].</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.BitcoindRpcErrorExt.html" title="trait bdk_bitcoind_rpc::BitcoindRpcErrorExt">Bitcoind<wbr>RpcError<wbr>Ext</a></div><div class="desc docblock-short">Extends [<code>bitcoincore_rpc::Error</code>].</div></li></ul></section></div></main></body></html>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.bitcoincore_rpc"><code>pub use bitcoincore_rpc;</code></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BlockEvent.html" title="struct bdk_bitcoind_rpc::BlockEvent">Block<wbr>Event</a></dt><dd>A newly emitted block from <a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a>.</dd><dt><a class="struct" href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter">Emitter</a></dt><dd>The <a href="struct.Emitter.html" title="struct bdk_bitcoind_rpc::Emitter"><code>Emitter</code></a> is used to emit data sourced from [<code>bitcoincore_rpc::Client</code>].</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.BitcoindRpcErrorExt.html" title="trait bdk_bitcoind_rpc::BitcoindRpcErrorExt">Bitcoind<wbr>RpcError<wbr>Ext</a></dt><dd>Extends [<code>bitcoincore_rpc::Error</code>].</dd></dl></section></div></main></body></html>
Loading

0 comments on commit f077dc8

Please sign in to comment.