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="Segregated Witness functionality - useful for enforcing parts of BIP-173 and BIP-350."><title>bdk_chain::bitcoin::bech32::primitives::segwit - 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_chain" 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="../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.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module segwit</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</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>segwit</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>Segregated Witness functionality - useful for enforcing parts of <a href="https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki">BIP-173</a> and <a href="https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki">BIP-350</a>.</p>
2 </div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.InvalidWitnessVersionError.html" title="struct bdk_chain::bitcoin::bech32::primitives::segwit::InvalidWitnessVersionError">Invalid<wbr>Witness<wbr>Version<wbr>Error</a></dt><dd>Field element does not represent a valid witness version.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.WitnessLengthError.html" title="enum bdk_chain::bitcoin::bech32::primitives::segwit::WitnessLengthError">Witness<wbr>Length<wbr>Error</a></dt><dd>Witness program invalid because of incorrect length.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.MAX_STRING_LENGTH.html" title="constant bdk_chain::bitcoin::bech32::primitives::segwit::MAX_STRING_LENGTH">MAX_<wbr>STRING_<wbr>LENGTH</a></dt><dd>The maximum enforced string length of a segwit address.</dd><dt><a class="constant" href="constant.VERSION_0.html" title="constant bdk_chain::bitcoin::bech32::primitives::segwit::VERSION_0">VERSION_<wbr>0</a></dt><dd>The field element representing segwit version 0.</dd><dt><a class="constant" href="constant.VERSION_1.html" title="constant bdk_chain::bitcoin::bech32::primitives::segwit::VERSION_1">VERSION_<wbr>1</a></dt><dd>The field element representing segwit version 1 (taproot).</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.is_valid_witness_program_length.html" title="fn bdk_chain::bitcoin::bech32::primitives::segwit::is_valid_witness_program_length">is_<wbr>valid_<wbr>witness_<wbr>program_<wbr>length</a></dt><dd>Returns true if <code>length</code> represents a valid witness program length for <code>witness_version</code>.</dd><dt><a class="fn" href="fn.is_valid_witness_version.html" title="fn bdk_chain::bitcoin::bech32::primitives::segwit::is_valid_witness_version">is_<wbr>valid_<wbr>witness_<wbr>version</a></dt><dd>Returns true if given field element represents a valid segwit version.</dd><dt><a class="fn" href="fn.validate_witness_program_length.html" title="fn bdk_chain::bitcoin::bech32::primitives::segwit::validate_witness_program_length">validate_<wbr>witness_<wbr>program_<wbr>length</a></dt><dd>Validates the segwit witness program <code>length</code> rules for witness <code>version</code>.</dd><dt><a class="fn" href="fn.validate_witness_version.html" title="fn bdk_chain::bitcoin::bech32::primitives::segwit::validate_witness_version">validate_<wbr>witness_<wbr>version</a></dt><dd>Checks that the given field element represents a valid segwit witness version.</dd></dl></section></div></main></body></html>
projects / bitcoindevkit.org / blob