]> Untitled Git - bitcoindevkit.org/commitdiff
Publish autogenerated nightly docs
authorgithub-actions <github-actions@github.com>
Wed, 16 Dec 2020 19:51:17 +0000 (19:51 +0000)
committergithub-actions <github-actions@github.com>
Wed, 16 Dec 2020 19:51:17 +0000 (19:51 +0000)
static/docs-rs/bdk/nightly/latest/bdk/blockchain/compact_filters/struct.Peer.html
static/docs-rs/bdk/nightly/latest/bdk/index.html
static/docs-rs/bdk/nightly/latest/src/bdk/blockchain/compact_filters/peer.rs.html
static/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html

index f3c7d428079bf280caa7b6484f359f5bf0288115..5c3eb0c9a99ae60ace9940bc26d408cbc59cdfac 100644 (file)
@@ -4,7 +4,7 @@
                 <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/bdk/blockchain/compact_filters/peer.rs.html#94-105" title="goto source code">[src]</a></span><span class="in-band">Struct <a href="../../index.html">bdk</a>::<wbr><a href="../index.html">blockchain</a>::<wbr><a href="index.html">compact_filters</a>::<wbr><a class="struct" href="">Peer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Peer { /* fields omitted */ }</pre></div><div class="item-info"><div class="stab portability">This is supported on <strong>crate feature <code>compact_filters</code></strong> only.</div></div><div class="docblock"><p>A Bitcoin peer</p>
 </div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../../bdk/blockchain/compact_filters/struct.Peer.html" title="struct bdk::blockchain::compact_filters::Peer">Peer</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../../src/bdk/blockchain/compact_filters/peer.rs.html#107-387" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.connect" class="method"><code>pub fn <a href="#method.connect" class="fnname">connect</a>&lt;A:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;address: A, <br>&nbsp;&nbsp;&nbsp;&nbsp;mempool: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../../bdk/blockchain/compact_filters/struct.Mempool.html" title="struct bdk::blockchain::compact_filters::Mempool">Mempool</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;network: Network<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../bdk/blockchain/compact_filters/enum.CompactFiltersError.html" title="enum bdk::blockchain::compact_filters::CompactFiltersError">CompactFiltersError</a>&gt;</code><a class="srclink" href="../../../src/bdk/blockchain/compact_filters/peer.rs.html#112-120" title="goto source code">[src]</a></h4><div class="docblock"><p>Connect to a peer over a plaintext TCP connection</p>
 <p>This function internally spawns a new thread that will monitor incoming messages from the
-peer, and optionally reply to some of them transparently, like <a href="NetworkMessage::Ping">pings</a></p>
+peer, and optionally reply to some of them transparently, like <a href="bitcoin::network::message::NetworkMessage::Ping">pings</a></p>
 </div><h4 id="method.connect_proxy" class="method"><code>pub fn <a href="#method.connect_proxy" class="fnname">connect_proxy</a>&lt;T:&nbsp;<a class="trait" href="https://docs.rs/socks/0.3.0/socks/trait.ToTargetAddr.html" title="trait socks::ToTargetAddr">ToTargetAddr</a>, P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/net/addr/trait.ToSocketAddrs.html" title="trait std::net::addr::ToSocketAddrs">ToSocketAddrs</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;target: T, <br>&nbsp;&nbsp;&nbsp;&nbsp;proxy: P, <br>&nbsp;&nbsp;&nbsp;&nbsp;credentials: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;mempool: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../../bdk/blockchain/compact_filters/struct.Mempool.html" title="struct bdk::blockchain::compact_filters::Mempool">Mempool</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;network: Network<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="../../../bdk/blockchain/compact_filters/enum.CompactFiltersError.html" title="enum bdk::blockchain::compact_filters::CompactFiltersError">CompactFiltersError</a>&gt;</code><a class="srclink" href="../../../src/bdk/blockchain/compact_filters/peer.rs.html#127-141" title="goto source code">[src]</a></h4><div class="docblock"><p>Connect to a peer through a SOCKS5 proxy, optionally by using some credentials, specified
 as a tuple of <code>(username, password)</code></p>
 <p>This function internally spawns a new thread that will monitor incoming messages from the
index 9661a018ad1f51d18878e872d161c3c9c3878f59..5f294ee3282520027adcc3f844d6c87d2d08b838 100644 (file)
@@ -17,7 +17,7 @@ essential for implementing descriptor based Bitcoin wallet applications in Rust.
 section, we will take a brief tour of BDK, summarizing the major APIs and
 their uses.</p>
 <p>The easiest way to get started is to add bdk to your dependencies with the default features.
-The default features include a simple key-value database (<a href="crate::sled"><code>sled</code></a>) to cache
+The default features include a simple key-value database (<a href="sled"><code>sled</code></a>) to cache
 blockchain data and an <a href="https://docs.rs/electrum-client/">electrum</a> blockchain client to
 interact with the bitcoin P2P network.</p>
 <pre><code class="language-toml">bdk = &quot;0.2.0&quot;
index c5b8064ce2723d1ce49187b9c1165e9c3831ca81..16eba3f0d0392e021c48df6b6c340c252f6eb3a7 100644 (file)
     <span class="doccomment">/// Connect to a peer over a plaintext TCP connection</span>
     <span class="doccomment">///</span>
     <span class="doccomment">/// This function internally spawns a new thread that will monitor incoming messages from the</span>
-    <span class="doccomment">/// peer, and optionally reply to some of them transparently, like [pings](NetworkMessage::Ping)</span>
+    <span class="doccomment">/// peer, and optionally reply to some of them transparently, like [pings](bitcoin::network::message::NetworkMessage::Ping)</span>
     <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">connect</span><span class="op">&lt;</span><span class="ident">A</span>: <span class="ident">ToSocketAddrs</span><span class="op">&gt;</span>(
         <span class="ident">address</span>: <span class="ident">A</span>,
         <span class="ident">mempool</span>: <span class="ident">Arc</span><span class="op">&lt;</span><span class="ident">Mempool</span><span class="op">&gt;</span>,
index c0f2b1e1c821e252618b8b52da9222c66f0d03b5..5c2f0d38cca386ecfd3669c06bb968e2bcebf227 100644 (file)
 <span class="doccomment">//! their uses.</span>
 <span class="doccomment">//!</span>
 <span class="doccomment">//! The easiest way to get started is to add bdk to your dependencies with the default features.</span>
-<span class="doccomment">//! The default features include a simple key-value database ([`sled`](crate::sled)) to cache</span>
+<span class="doccomment">//! The default features include a simple key-value database ([`sled`](sled)) to cache</span>
 <span class="doccomment">//! blockchain data and an [electrum](https://docs.rs/electrum-client/) blockchain client to</span>
 <span class="doccomment">//! interact with the bitcoin P2P network.</span>
 <span class="doccomment">//!</span>