Untitled Git - bitcoindevkit.org/blob

   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="Format known-length array as hex."><title>fmt_hex_exact in bdk_chain::bitcoin::hashes::hex::display - 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 (a4cb3c831 2024-12-17)" 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 macro"><!--[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="#">fmt_<wbr>hex_<wbr>exact</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#parameters" title="Parameters">Parameters</a></li><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bdk_<wbr>chain::<wbr>bitcoin::<wbr>hashes::<wbr>hex::<wbr>display</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">hashes</a>::<wbr><a href="../index.html">hex</a>::<wbr><a href="index.html">display</a></span><h1>Macro <span class="macro">fmt_hex_exact</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><pre class="rust item-decl"><code>macro_rules! fmt_hex_exact {
   2     ($formatter:expr, $len:expr, $bytes:expr, $case:expr) =&gt; { ... };
   3 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Format known-length array as hex.</p>
   4 <p>This supports all formatting options of formatter and may be faster than calling <code>as_hex()</code> on
   5 an arbitrary <code>&amp;[u8]</code>. Note that the implementation intentionally keeps leading zeros even when
   6 not requested. This is designed to display values such as hashes and keys and removing leading
   7 zeros would be confusing.</p>
   8 <p>Note that the bytes parameter is <code>IntoIterator</code> this means that if you would like to do some
   9 manipulation to the byte array before formatting then you can. For example <code>bytes.iter().rev()</code>
  10 to print the array backwards.</p>
  11 <h3 id="parameters"><a class="doc-anchor" href="#parameters">§</a>Parameters</h3>
  12 <ul>
  13 <li><code>$formatter</code> - a <a href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter"><code>fmt::Formatter</code></a>.</li>
  14 <li><code>$len</code> known length of <code>$bytes</code>, must be a const expression.</li>
  15 <li><code>$bytes</code> - bytes to be encoded, most likely a reference to an array.</li>
  16 <li><code>$case</code> - value of type <a href="../enum.Case.html" title="enum bdk_chain::bitcoin::hashes::hex::Case"><code>Case</code></a> determining whether to format as lower or upper case.</li>
  17 </ul>
  18 <h3 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h3>
  19 <p>This macro panics if <code>$len</code> is not equal to <code>$bytes.len()</code>. It also fails to compile if <code>$len</code>
  20 is more than half of <code>usize::MAX</code>.</p>
  21 </div></details></section></div></main></body></html>