Skip to content

Commit c1a2712

Browse files
author
github-actions
committed
Publish autogenerated nightly docs
1 parent b199609 commit c1a2712

File tree

374 files changed

+6607
-1021
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

374 files changed

+6607
-1021
lines changed

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/all.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/address/enum.FromScriptError.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/address/enum.ParseError.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/address/error/enum.FromScriptError.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/address/error/enum.ParseError.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/address/struct.Address.html

Lines changed: 2 additions & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/amount/enum.ParseAmountError.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/amount/struct.Amount.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/amount/struct.SignedAmount.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/base58/enum.Error.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/base58/error/enum.Error.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/base58/struct.String.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/base58/struct.Vec.html

Lines changed: 57 additions & 57 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.Bech32.html

Lines changed: 31 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.Bech32m.html

Lines changed: 31 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.DecodeError.html

Lines changed: 24 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.EncodeError.html

Lines changed: 24 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.EncodeIoError.html

Lines changed: 19 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/enum.NoChecksum.html

Lines changed: 31 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/fn.decode.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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="Decodes a bech32 encoded string."><title>decode in bdk_chain::bitcoin::bech32 - 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_chain" 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 fn"><!--[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_chain/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_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.20.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In bdk_chain::bitcoin::bech32</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>Function <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">bitcoin</a>::<wbr><a href="index.html">bech32</a>::<wbr><a class="fn" href="#">decode</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn decode(s: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&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="struct" href="struct.Hrp.html" title="struct bdk_chain::bitcoin::bech32::Hrp">Hrp</a>, <a class="struct" href="../base58/struct.Vec.html" title="struct bdk_chain::bitcoin::base58::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;), <a class="enum" href="enum.DecodeError.html" title="enum bdk_chain::bitcoin::bech32::DecodeError">DecodeError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decodes a bech32 encoded string.</p>
2+
<p>If this function succeeds the input string was found to be well formed (hrp, separator, bech32
3+
characters), and to have either a valid bech32m checksum or a valid bech32 checksum.</p>
4+
<p>If your input string has no checksum use the [<code>CheckedHrpstring</code>] constructor, which allows
5+
selecting the checksum algorithm explicitly.</p>
6+
<h2 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h2>
7+
<p>The human-readable part and the encoded data with the checksum removed.</p>
8+
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
9+
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bech32::{decode, Bech32, Bech32m, NoChecksum};
10+
<span class="kw">use </span>bech32::primitives::decode::CheckedHrpstring;
11+
12+
<span class="kw">const </span>BECH32: <span class="kw-2">&amp;</span>str = <span class="string">"abc14w46h2at4w46h2at4w46h2at4w46h2atsghld7"</span>;
13+
<span class="kw">const </span>BECH32M: <span class="kw-2">&amp;</span>str = <span class="string">"abc14w46h2at4w46h2at4w46h2at4w46h2at958ngu"</span>;
14+
<span class="kw">const </span>NO_CHECKSUM: <span class="kw-2">&amp;</span>str = <span class="string">"abc14w46h2at4w46h2at4w46h2at4w46h2at"</span>;
15+
16+
<span class="kw">let </span>(hrp, data) = decode(<span class="kw-2">&amp;</span>BECH32).expect(<span class="string">"valid bech32 string with valid bech32 checksum"</span>);
17+
<span class="kw">let </span>(hrp, data) = decode(<span class="kw-2">&amp;</span>BECH32M).expect(<span class="string">"valid bech32 string with valid bech32m checksum"</span>);
18+
<span class="macro">assert!</span>(decode(<span class="kw-2">&amp;</span>NO_CHECKSUM).is_err());
19+
20+
<span class="comment">// You can control the checksum algorithm directly by using the [`CheckedHrpstring`] type.
21+
</span><span class="kw">let </span>p = CheckedHrpstring::new::&lt;Bech32&gt;(<span class="kw-2">&amp;</span>BECH32).expect(<span class="string">"valid bech32 string with valid bech32 checksum"</span>);
22+
<span class="kw">let </span>p = CheckedHrpstring::new::&lt;Bech32m&gt;(<span class="kw-2">&amp;</span>BECH32M).expect(<span class="string">"valid bech32 string with valid bech32 checksum"</span>);
23+
<span class="kw">let </span>p = CheckedHrpstring::new::&lt;NoChecksum&gt;(<span class="kw-2">&amp;</span>NO_CHECKSUM).expect(<span class="string">"valid bech32 string with no checksum"</span>);</code></pre></div>
24+
</div></details></section></div></main></body></html>

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/fn.encode.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
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="Encodes `data` as a lowercase bech32 encoded string."><title>encode in bdk_chain::bitcoin::bech32 - 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_chain" 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 fn"><!--[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_chain/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_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.20.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In bdk_chain::bitcoin::bech32</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>Function <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">bitcoin</a>::<wbr><a href="index.html">bech32</a>::<wbr><a class="fn" href="#">encode</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn encode&lt;Ck&gt;(hrp: <a class="struct" href="struct.Hrp.html" title="struct bdk_chain::bitcoin::bech32::Hrp">Hrp</a>, data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -&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="struct" href="../base58/struct.String.html" title="struct bdk_chain::bitcoin::base58::String">String</a>, <a class="enum" href="enum.EncodeError.html" title="enum bdk_chain::bitcoin::bech32::EncodeError">EncodeError</a>&gt;<div class="where">where
2+
Ck: <a class="trait" href="trait.Checksum.html" title="trait bdk_chain::bitcoin::bech32::Checksum">Checksum</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encodes <code>data</code> as a lowercase bech32 encoded string.</p>
3+
<p>Encoded string will be prefixed with the <code>hrp</code> and have a checksum appended as specified by the
4+
<code>Ck</code> algorithm (<code>NoChecksum</code> to exclude checksum all together).</p>
5+
</div></details></section></div></main></body></html>

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/fn.encode_lower.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
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="Encodes `data` as a lowercase bech32 encoded string."><title>encode_lower in bdk_chain::bitcoin::bech32 - 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_chain" 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 fn"><!--[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_chain/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_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.20.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In bdk_chain::bitcoin::bech32</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>Function <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">bitcoin</a>::<wbr><a href="index.html">bech32</a>::<wbr><a class="fn" href="#">encode_lower</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn encode_lower&lt;Ck&gt;(hrp: <a class="struct" href="struct.Hrp.html" title="struct bdk_chain::bitcoin::bech32::Hrp">Hrp</a>, data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -&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="struct" href="../base58/struct.String.html" title="struct bdk_chain::bitcoin::base58::String">String</a>, <a class="enum" href="enum.EncodeError.html" title="enum bdk_chain::bitcoin::bech32::EncodeError">EncodeError</a>&gt;<div class="where">where
2+
Ck: <a class="trait" href="trait.Checksum.html" title="trait bdk_chain::bitcoin::bech32::Checksum">Checksum</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encodes <code>data</code> as a lowercase bech32 encoded string.</p>
3+
<p>Encoded string will be prefixed with the <code>hrp</code> and have a checksum appended as specified by the
4+
<code>Ck</code> algorithm (<code>NoChecksum</code> to exclude checksum all together).</p>
5+
</div></details></section></div></main></body></html>

‎docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/bitcoin/bech32/fn.encode_lower_to_fmt.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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="Encodes `data` to a writer (`fmt::Write`) as a lowercase bech32 encoded string."><title>encode_lower_to_fmt in bdk_chain::bitcoin::bech32 - 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_chain" 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 fn"><!--[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_chain/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_chain/index.html"><img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><h2><a href="../../../bdk_chain/index.html">bdk_chain</a><span class="version">0.20.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In bdk_chain::bitcoin::bech32</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>Function <a href="../../index.html">bdk_chain</a>::<wbr><a href="../index.html">bitcoin</a>::<wbr><a href="index.html">bech32</a>::<wbr><a class="fn" href="#">encode_lower_to_fmt</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn encode_lower_to_fmt&lt;Ck, W&gt;(
2+
fmt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut W</a>,
3+
hrp: <a class="struct" href="struct.Hrp.html" title="struct bdk_chain::bitcoin::bech32::Hrp">Hrp</a>,
4+
data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]
5+
) -&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="enum" href="enum.EncodeError.html" title="enum bdk_chain::bitcoin::bech32::EncodeError">EncodeError</a>&gt;<div class="where">where
6+
Ck: <a class="trait" href="trait.Checksum.html" title="trait bdk_chain::bitcoin::bech32::Checksum">Checksum</a>,
7+
W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html" title="trait core::fmt::Write">Write</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encodes <code>data</code> to a writer (<a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Write.html" title="trait core::fmt::Write"><code>fmt::Write</code></a>) as a lowercase bech32 encoded string.</p>
8+
<p>Encoded string will be prefixed with the <code>hrp</code> and have a checksum appended as specified by the
9+
<code>Ck</code> algorithm (<code>NoChecksum</code> to exclude checksum all together).</p>
10+
</div></details></section></div></main></body></html>

0 commit comments

Comments
 (0)