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="Provides an instance of string-to-byte decoder."><title>ByteDecoder in bdk_chain::bitcoin::consensus::serde - 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="#">Byte<wbr>Decoder</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.DecodeError" title="DecodeError">DecodeError</a></li><li><a href="#associatedtype.Decoder" title="Decoder">Decoder</a></li><li><a href="#associatedtype.InitError" title="InitError">InitError</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_str" title="from_str">from_str</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>serde</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">serde</a></span><h1>Trait <span class="trait">ByteDecoder</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 ByteDecoder<'a> {
2 type <a href="#associatedtype.InitError" class="associatedtype">InitError</a>: <a class="trait" href="trait.IntoDeError.html" title="trait bdk_chain::bitcoin::consensus::serde::IntoDeError">IntoDeError</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
3 type <a href="#associatedtype.DecodeError" class="associatedtype">DecodeError</a>: <a class="trait" href="trait.IntoDeError.html" title="trait bdk_chain::bitcoin::consensus::serde::IntoDeError">IntoDeError</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>;
4 type <a href="#associatedtype.Decoder" class="associatedtype">Decoder</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <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>, Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.DecodeError" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::DecodeError">DecodeError</a>>>;
7 fn <a href="#tymethod.from_str" class="fn">from_str</a>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.Decoder" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::Decoder">Decoder</a>, Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.InitError" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::InitError">InitError</a>>;
8 }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides an instance of string-to-byte decoder.</p>
9 <p>This is basically a type constructor used in places where value arguments are not accepted.
10 Such as the generic <code>serialize</code>.</p>
11 </div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.InitError" class="method"><h4 class="code-header">type <a href="#associatedtype.InitError" class="associatedtype">InitError</a>: <a class="trait" href="trait.IntoDeError.html" title="trait bdk_chain::bitcoin::consensus::serde::IntoDeError">IntoDeError</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section></summary><div class="docblock"><p>Error returned when decoder can’t be created.</p>
12 <p>This is typically returned when string length is invalid.</p>
13 </div></details><details class="toggle" open><summary><section id="associatedtype.DecodeError" class="method"><h4 class="code-header">type <a href="#associatedtype.DecodeError" class="associatedtype">DecodeError</a>: <a class="trait" href="trait.IntoDeError.html" title="trait bdk_chain::bitcoin::consensus::serde::IntoDeError">IntoDeError</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></h4></section></summary><div class="docblock"><p>Error returned when decoding fails.</p>
14 <p>This is typically returned when the input string contains malformed chars.</p>
15 </div></details><details class="toggle" open><summary><section id="associatedtype.Decoder" class="method"><h4 class="code-header">type <a href="#associatedtype.Decoder" class="associatedtype">Decoder</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <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>, Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.DecodeError" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::DecodeError">DecodeError</a>>></h4></section></summary><div class="docblock"><p>The decoder state.</p>
16 </div></details></div><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.from_str" class="method"><h4 class="code-header">fn <a href="#tymethod.from_str" class="fn">from_str</a>(s: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.Decoder" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::Decoder">Decoder</a>, Self::<a class="associatedtype" href="trait.ByteDecoder.html#associatedtype.InitError" title="type bdk_chain::bitcoin::consensus::serde::ByteDecoder::InitError">InitError</a>></h4></section></summary><div class="docblock"><p>Constructs the decoder from string.</p>
17 </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"><details class="toggle implementors-toggle"><summary><section id="impl-ByteDecoder%3C'a%3E-for-Hex%3CC%3E" class="impl"><a href="#impl-ByteDecoder%3C'a%3E-for-Hex%3CC%3E" class="anchor">§</a><h3 class="code-header">impl<'a, C> <a class="trait" href="trait.ByteDecoder.html" title="trait bdk_chain::bitcoin::consensus::serde::ByteDecoder">ByteDecoder</a><'a> for <a class="struct" href="struct.Hex.html" title="struct bdk_chain::bitcoin::consensus::serde::Hex">Hex</a><C><div class="where">where
18 C: <a class="trait" href="hex/trait.Case.html" title="trait bdk_chain::bitcoin::consensus::serde::hex::Case">Case</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.InitError-1" class="associatedtype trait-impl"><a href="#associatedtype.InitError-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.InitError" class="associatedtype">InitError</a> = <a class="struct" href="hex/struct.DecodeInitError.html" title="struct bdk_chain::bitcoin::consensus::serde::hex::DecodeInitError">DecodeInitError</a></h4></section><section id="associatedtype.DecodeError-1" class="associatedtype trait-impl"><a href="#associatedtype.DecodeError-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.DecodeError" class="associatedtype">DecodeError</a> = <a class="struct" href="hex/struct.DecodeError.html" title="struct bdk_chain::bitcoin::consensus::serde::hex::DecodeError">DecodeError</a></h4></section><section id="associatedtype.Decoder-1" class="associatedtype trait-impl"><a href="#associatedtype.Decoder-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Decoder" class="associatedtype">Decoder</a> = <a class="struct" href="hex/struct.Decoder.html" title="struct bdk_chain::bitcoin::consensus::serde::hex::Decoder">Decoder</a><'a></h4></section></div></details></div><script src="../../../../trait.impl/bitcoin/consensus/serde/trait.ByteDecoder.js" data-ignore-extern-crates="bitcoin" async></script></section></div></main></body></html>
projects / bitcoindevkit.org / blob