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="Bech32 address encoding."><title>bdk_chain::bitcoin::bech32::primitives::encode - 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-46132b98.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.85.0-nightly (6d9f6ae36 2024-12-16)" data-channel="nightly" data-search-js="search-036cda7a.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 mod"><!--[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_<wbr>chain</a><span class="version">0.21.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module encode</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In bdk_<wbr>chain::<wbr>bitcoin::<wbr>bech32::<wbr>primitives</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_chain</a>::<wbr><a href="../../../index.html">bitcoin</a>::<wbr><a href="../../index.html">bech32</a>::<wbr><a href="../index.html">primitives</a></span><h1>Module <span>encode</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Bech32 address encoding.</p>
2 <p>This module provides types and iterators that can be used to encode data as a bech32 address in
3 a variety of ways without any allocations, generating, verifying, and appending checksums,
4 prepending HRP strings etc.</p>
5 <p>In general, directly using these adaptors is not very ergonomic, and users are recommended to
6 instead use the crate level API.</p>
7 <p>WARNING: This module does not enforce the maximum length of an encoded bech32 string (90 chars).</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::{Bech32, ByteIterExt, Fe32IterExt, Fe32, Hrp};
11 <span class="kw">let </span>witness_prog = [
12 <span class="number">0x75</span>, <span class="number">0x1e</span>, <span class="number">0x76</span>, <span class="number">0xe8</span>, <span class="number">0x19</span>, <span class="number">0x91</span>, <span class="number">0x96</span>, <span class="number">0xd4</span>,
13 <span class="number">0x54</span>, <span class="number">0x94</span>, <span class="number">0x1c</span>, <span class="number">0x45</span>, <span class="number">0xd1</span>, <span class="number">0xb3</span>, <span class="number">0xa3</span>, <span class="number">0x23</span>,
14 <span class="number">0xf1</span>, <span class="number">0x43</span>, <span class="number">0x3b</span>, <span class="number">0xd6</span>,
17 <span class="comment">// Get a stream of characters representing the bech32 encoded
18 // address using "bc" for the human-readable part.
19 </span><span class="kw">let </span>hrp = Hrp::parse(<span class="string">"bc"</span>).expect(<span class="string">"bc is valid hrp string"</span>);
20 <span class="kw">let </span>chars = witness_prog
24 .with_checksum::<Bech32>(<span class="kw-2">&</span>hrp)
25 .with_witness_version(Fe32::Q) <span class="comment">// Optionally add witness version.
28 <span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
30 <span class="kw">let </span>addr = chars.collect::<String>();
31 <span class="macro">assert_eq!</span>(addr.to_uppercase(), <span class="string">"BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4"</span>);
33 </div></details><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.ByteIter.html" title="struct bdk_chain::bitcoin::bech32::primitives::encode::ByteIter">Byte<wbr>Iter</a></div><div class="desc docblock-short">Iterator adaptor which takes a stream of ASCII field elements (an encoded string) and yields a stream of bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.CharIter.html" title="struct bdk_chain::bitcoin::bech32::primitives::encode::CharIter">Char<wbr>Iter</a></div><div class="desc docblock-short">Iterator adaptor which takes a stream of field elements, converts it to characters prefixed by
34 an HRP (and separator), and suffixed by the checksum i.e., converts the data in a stream of
35 field elements into stream of characters representing the encoded bech32 string.</div></li><li><div class="item-name"><a class="struct" href="struct.Encoder.html" title="struct bdk_chain::bitcoin::bech32::primitives::encode::Encoder">Encoder</a></div><div class="desc docblock-short">The <code>Encoder</code> builds iterators that can be used to encode field elements into a bech32 address.</div></li><li><div class="item-name"><a class="struct" href="struct.Fe32Iter.html" title="struct bdk_chain::bitcoin::bech32::primitives::encode::Fe32Iter">Fe32<wbr>Iter</a></div><div class="desc docblock-short">Iterator adaptor for a checksummed iterator that inputs the HRP into the checksum algorithm
36 before yielding the HRP as field elements followed by the data then checksum.</div></li><li><div class="item-name"><a class="struct" href="struct.WitnessVersionIter.html" title="struct bdk_chain::bitcoin::bech32::primitives::encode::WitnessVersionIter">Witness<wbr>Version<wbr>Iter</a></div><div class="desc docblock-short">Iterator adaptor that just prepends a single character to a field element stream.</div></li></ul></section></div></main></body></html>
projects / bitcoindevkit.org / blob