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="Source of the Rust file `src/descriptor/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.rs - source</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
2 <link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
3 <link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../bdk/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
4 <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
10 <span id="7"> 7</span>
11 <span id="8"> 8</span>
12 <span id="9"> 9</span>
13 <span id="10">10</span>
14 <span id="11">11</span>
15 <span id="12">12</span>
16 <span id="13">13</span>
17 <span id="14">14</span>
18 <span id="15">15</span>
19 <span id="16">16</span>
20 <span id="17">17</span>
21 <span id="18">18</span>
22 <span id="19">19</span>
23 <span id="20">20</span>
24 <span id="21">21</span>
25 <span id="22">22</span>
26 <span id="23">23</span>
27 <span id="24">24</span>
28 <span id="25">25</span>
29 <span id="26">26</span>
30 <span id="27">27</span>
31 <span id="28">28</span>
32 <span id="29">29</span>
33 <span id="30">30</span>
34 <span id="31">31</span>
35 <span id="32">32</span>
36 <span id="33">33</span>
37 <span id="34">34</span>
38 <span id="35">35</span>
39 <span id="36">36</span>
40 <span id="37">37</span>
41 <span id="38">38</span>
42 <span id="39">39</span>
43 <span id="40">40</span>
44 <span id="41">41</span>
45 <span id="42">42</span>
46 <span id="43">43</span>
47 <span id="44">44</span>
48 <span id="45">45</span>
49 <span id="46">46</span>
50 <span id="47">47</span>
51 <span id="48">48</span>
52 <span id="49">49</span>
53 <span id="50">50</span>
54 <span id="51">51</span>
55 <span id="52">52</span>
56 <span id="53">53</span>
57 <span id="54">54</span>
58 <span id="55">55</span>
59 <span id="56">56</span>
60 <span id="57">57</span>
61 <span id="58">58</span>
62 <span id="59">59</span>
63 <span id="60">60</span>
64 <span id="61">61</span>
65 <span id="62">62</span>
66 <span id="63">63</span>
67 <span id="64">64</span>
68 <span id="65">65</span>
69 <span id="66">66</span>
70 <span id="67">67</span>
71 <span id="68">68</span>
72 <span id="69">69</span>
73 <span id="70">70</span>
74 <span id="71">71</span>
75 <span id="72">72</span>
76 <span id="73">73</span>
77 <span id="74">74</span>
78 <span id="75">75</span>
79 <span id="76">76</span>
80 <span id="77">77</span>
81 <span id="78">78</span>
82 <span id="79">79</span>
83 <span id="80">80</span>
84 <span id="81">81</span>
85 <span id="82">82</span>
86 <span id="83">83</span>
87 <span id="84">84</span>
88 <span id="85">85</span>
89 </pre><div class="example-wrap"><pre class="rust ">
90 <span class="comment">// Magical Bitcoin Library</span>
91 <span class="comment">// Written in 2020 by</span>
92 <span class="comment">// Alekos Filini <alekos.filini@gmail.com></span>
93 <span class="comment">//</span>
94 <span class="comment">// Copyright (c) 2020 Magical Bitcoin</span>
95 <span class="comment">//</span>
96 <span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span>
97 <span class="comment">// of this software and associated documentation files (the "Software"), to deal</span>
98 <span class="comment">// in the Software without restriction, including without limitation the rights</span>
99 <span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
100 <span class="comment">// copies of the Software, and to permit persons to whom the Software is</span>
101 <span class="comment">// furnished to do so, subject to the following conditions:</span>
102 <span class="comment">//</span>
103 <span class="comment">// The above copyright notice and this permission notice shall be included in all</span>
104 <span class="comment">// copies or substantial portions of the Software.</span>
105 <span class="comment">//</span>
106 <span class="comment">// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
107 <span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
108 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
109 <span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
110 <span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
111 <span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
112 <span class="comment">// SOFTWARE.</span>
114 <span class="doccomment">//! Descriptor errors</span>
116 <span class="doccomment">/// Errors related to the parsing and usage of descriptors</span>
117 <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
118 <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> {
119 <span class="comment">//InternalError,</span>
120 <span class="comment">//InvalidPrefix(Vec<u8>),</span>
121 <span class="comment">//HardenedDerivationOnXpub,</span>
122 <span class="comment">//MalformedInput,</span>
123 <span class="doccomment">/// Invalid HD Key path, such as having a wildcard but a length != 1</span>
124 <span class="ident">InvalidHDKeyPath</span>,
126 <span class="comment">//KeyParsingError(String),</span>
127 <span class="doccomment">/// Error thrown while working with [`keys`](crate::keys)</span>
128 <span class="ident">Key</span>(<span class="kw">crate</span>::<span class="ident">keys</span>::<span class="ident">KeyError</span>),
129 <span class="doccomment">/// Error while extracting and manipulating policies</span>
130 <span class="ident">Policy</span>(<span class="kw">crate</span>::<span class="ident">descriptor</span>::<span class="ident">policy</span>::<span class="ident">PolicyError</span>),
132 <span class="comment">//InputIndexDoesntExist,</span>
133 <span class="comment">//MissingPublicKey,</span>
134 <span class="comment">//MissingDetails,</span>
135 <span class="doccomment">/// Invalid character found in the descriptor checksum</span>
136 <span class="ident">InvalidDescriptorCharacter</span>(<span class="ident">char</span>),
138 <span class="comment">//CantDeriveWithMiniscript,</span>
139 <span class="doccomment">/// BIP32 error</span>
140 <span class="ident">BIP32</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">bip32</span>::<span class="ident">Error</span>),
141 <span class="doccomment">/// Error during base58 decoding</span>
142 <span class="ident">Base58</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">base58</span>::<span class="ident">Error</span>),
143 <span class="doccomment">/// Key-related error</span>
144 <span class="ident">PK</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">key</span>::<span class="ident">Error</span>),
145 <span class="doccomment">/// Miniscript error</span>
146 <span class="ident">Miniscript</span>(<span class="ident">miniscript</span>::<span class="ident">Error</span>),
147 <span class="doccomment">/// Hex decoding error</span>
148 <span class="ident">Hex</span>(<span class="ident">bitcoin</span>::<span class="ident">hashes</span>::<span class="ident">hex</span>::<span class="ident">Error</span>),
151 <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw">crate</span>::<span class="ident">keys</span>::<span class="ident">KeyError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Error</span> {
152 <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">key_error</span>: <span class="kw">crate</span>::<span class="ident">keys</span>::<span class="ident">KeyError</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Error</span> {
153 <span class="kw">match</span> <span class="ident">key_error</span> {
154 <span class="kw">crate</span>::<span class="ident">keys</span>::<span class="ident">KeyError</span>::<span class="ident">Miniscript</span>(<span class="ident">inner</span>) <span class="op">=</span><span class="op">></span> <span class="ident">Error</span>::<span class="ident">Miniscript</span>(<span class="ident">inner</span>),
155 <span class="kw">crate</span>::<span class="ident">keys</span>::<span class="ident">KeyError</span>::<span class="ident">BIP32</span>(<span class="ident">inner</span>) <span class="op">=</span><span class="op">></span> <span class="ident">Error</span>::<span class="ident">BIP32</span>(<span class="ident">inner</span>),
156 <span class="ident">e</span> <span class="op">=</span><span class="op">></span> <span class="ident">Error</span>::<span class="ident">Key</span>(<span class="ident">e</span>),
161 <span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Error</span> {
162 <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">std</span>::<span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
163 <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{:?}"</span>, <span class="self">self</span>)
167 <span class="kw">impl</span> <span class="ident">std</span>::<span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">Error</span> {}
169 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">bip32</span>::<span class="ident">Error</span>, <span class="ident">BIP32</span>);
170 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">base58</span>::<span class="ident">Error</span>, <span class="ident">Base58</span>);
171 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="ident">bitcoin</span>::<span class="ident">util</span>::<span class="ident">key</span>::<span class="ident">Error</span>, <span class="ident">PK</span>);
172 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="ident">miniscript</span>::<span class="ident">Error</span>, <span class="ident">Miniscript</span>);
173 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="ident">bitcoin</span>::<span class="ident">hashes</span>::<span class="ident">hex</span>::<span class="ident">Error</span>, <span class="ident">Hex</span>);
174 <span class="macro">impl_error</span><span class="macro">!</span>(<span class="kw">crate</span>::<span class="ident">descriptor</span>::<span class="ident">policy</span>::<span class="ident">PolicyError</span>, <span class="ident">Policy</span>);
176 </section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../";window.currentCrate = "bdk";</script><script src="../../../main.js"></script><script src="../../../source-script.js"></script><script src="../../../source-files.js"></script><script defer src="../../../search-index.js"></script></body></html>
projects / bitcoindevkit.org / blob