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="Extensions of `Read` to decode data as per Bitcoin consensus."><title>ReadExt in bdk_chain::bitcoin::consensus::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 trait"><!--[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="#">ReadExt</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.read_bool" title="read_bool">read_bool</a></li><li><a href="#tymethod.read_i16" title="read_i16">read_i16</a></li><li><a href="#tymethod.read_i32" title="read_i32">read_i32</a></li><li><a href="#tymethod.read_i64" title="read_i64">read_i64</a></li><li><a href="#tymethod.read_i8" title="read_i8">read_i8</a></li><li><a href="#tymethod.read_slice" title="read_slice">read_slice</a></li><li><a href="#tymethod.read_u16" title="read_u16">read_u16</a></li><li><a href="#tymethod.read_u32" title="read_u32">read_u32</a></li><li><a href="#tymethod.read_u64" title="read_u64">read_u64</a></li><li><a href="#tymethod.read_u8" title="read_u8">read_u8</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bdk_<wbr>chain::<wbr>bitcoin::<wbr>consensus::<wbr>encode</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">consensus</a>::<wbr><a href="index.html">encode</a></span><h1>Trait <span class="trait">ReadExt</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>pub trait ReadExt: <a class="trait" href="../../io/trait.Read.html" title="trait bdk_chain::bitcoin::io::Read">Read</a> {
3 fn <a href="#tymethod.read_u64" class="fn">read_u64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
4 <span class="item-spacer"></span> fn <a href="#tymethod.read_u32" class="fn">read_u32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
5 <span class="item-spacer"></span> fn <a href="#tymethod.read_u16" class="fn">read_u16</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
6 <span class="item-spacer"></span> fn <a href="#tymethod.read_u8" class="fn">read_u8</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
7 <span class="item-spacer"></span> fn <a href="#tymethod.read_i64" class="fn">read_i64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
8 <span class="item-spacer"></span> fn <a href="#tymethod.read_i32" class="fn">read_i32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
9 <span class="item-spacer"></span> fn <a href="#tymethod.read_i16" class="fn">read_i16</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
10 <span class="item-spacer"></span> fn <a href="#tymethod.read_i8" class="fn">read_i8</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
11 <span class="item-spacer"></span> fn <a href="#tymethod.read_bool" class="fn">read_bool</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
12 <span class="item-spacer"></span> fn <a href="#tymethod.read_slice" class="fn">read_slice</a>(&mut self, slice: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>>;
13 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extensions of <code>Read</code> to decode data as per Bitcoin consensus.</p>
14 </div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.read_u64" class="method"><h4 class="code-header">fn <a href="#tymethod.read_u64" class="fn">read_u64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 64-bit unsigned integer.</p>
15 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_u32" class="method"><h4 class="code-header">fn <a href="#tymethod.read_u32" class="fn">read_u32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 32-bit unsigned integer.</p>
16 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_u16" class="method"><h4 class="code-header">fn <a href="#tymethod.read_u16" class="fn">read_u16</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 16-bit unsigned integer.</p>
17 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_u8" class="method"><h4 class="code-header">fn <a href="#tymethod.read_u8" class="fn">read_u8</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads an 8-bit unsigned integer.</p>
18 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_i64" class="method"><h4 class="code-header">fn <a href="#tymethod.read_i64" class="fn">read_i64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 64-bit signed integer.</p>
19 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_i32" class="method"><h4 class="code-header">fn <a href="#tymethod.read_i32" class="fn">read_i32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 32-bit signed integer.</p>
20 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_i16" class="method"><h4 class="code-header">fn <a href="#tymethod.read_i16" class="fn">read_i16</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a 16-bit signed integer.</p>
21 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_i8" class="method"><h4 class="code-header">fn <a href="#tymethod.read_i8" class="fn">read_i8</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads an 8-bit signed integer.</p>
22 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_bool" class="method"><h4 class="code-header">fn <a href="#tymethod.read_bool" class="fn">read_bool</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a boolean.</p>
23 </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_slice" class="method"><h4 class="code-header">fn <a href="#tymethod.read_slice" class="fn">read_slice</a>(&mut self, slice: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="enum.Error.html" title="enum bdk_chain::bitcoin::consensus::encode::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads a byte slice.</p>
24 </div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ReadExt-for-R" class="impl"><a href="#impl-ReadExt-for-R" class="anchor">§</a><h3 class="code-header">impl<R> <a class="trait" href="../trait.ReadExt.html" title="trait bdk_chain::bitcoin::consensus::ReadExt">ReadExt</a> for R<div class="where">where
25 R: <a class="trait" href="../../io/trait.Read.html" title="trait bdk_chain::bitcoin::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></div><script src="../../../../trait.impl/bitcoin/consensus/encode/trait.ReadExt.js" async></script></section></div></main></body></html>
projects / bitcoindevkit.org / blob