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="Iterator Adaptors."><title>bdk_chain::bitcoin::bech32::primitives::iter - 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 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_chain</a><span class="version">0.20.0</span></h2></div><h2 class="location"><a href="#">Module iter</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section><h2><a href="../index.html">In bdk_chain::bitcoin::bech32::primitives</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>Module <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>::<wbr><a class="mod" href="#">iter</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>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Iterator Adaptors.</p>
2 <p>Iterator extension traits and blanket implementations to convert:</p>
4 <li><code>BytesToFes</code>: An iterator over bytes to an iterator over field elements.</li>
5 <li><code>FesToBytes</code>: An iterator over field elements to an iterator over bytes.</li>
6 <li><code>Checksummed</code>: An iterator over field elements that appends the checksum.</li>
8 <p>WARNING: This module does not enforce the maximum length of an encoded bech32 string (90 chars).</p>
9 <h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
10 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bech32::{Bech32, ByteIterExt, Fe32IterExt, Fe32, Hrp};
12 <span class="kw">let </span>data = [
13 <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>,
14 <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>,
15 <span class="number">0xf1</span>, <span class="number">0x43</span>, <span class="number">0x3b</span>, <span class="number">0xd6</span>,
18 <span class="comment">// Convert byte data to GF32 field elements.
19 </span><span class="kw">let </span>fe_iter = data.iter().copied().bytes_to_fes();
21 <span class="comment">// Convert field elements back to bytes.
22 </span><span class="kw">let </span>byte_iter = fe_iter.fes_to_bytes();
24 </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.BytesToFes.html" title="struct bdk_chain::bitcoin::bech32::primitives::iter::BytesToFes">BytesToFes</a></div><div class="desc docblock-short">Iterator adaptor that converts bytes to GF32 elements.</div></li><li><div class="item-name"><a class="struct" href="struct.Checksummed.html" title="struct bdk_chain::bitcoin::bech32::primitives::iter::Checksummed">Checksummed</a></div><div class="desc docblock-short">Iterator adaptor for field-element-yielding iterator, which tacks a checksum onto the end of the
25 yielded data.</div></li><li><div class="item-name"><a class="struct" href="struct.FesToBytes.html" title="struct bdk_chain::bitcoin::bech32::primitives::iter::FesToBytes">FesToBytes</a></div><div class="desc docblock-short">Iterator adaptor that converts GF32 elements to bytes.</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.ByteIterExt.html" title="trait bdk_chain::bitcoin::bech32::primitives::iter::ByteIterExt">ByteIterExt</a></div><div class="desc docblock-short">Extension trait for byte iterators which provides an adaptor to GF32 elements.</div></li><li><div class="item-name"><a class="trait" href="trait.Fe32IterExt.html" title="trait bdk_chain::bitcoin::bech32::primitives::iter::Fe32IterExt">Fe32IterExt</a></div><div class="desc docblock-short">Extension trait for field element iterators.</div></li></ul></section></div></main></body></html>
projects / bitcoindevkit.org / blob