blob: 9790f24013faba19c8593f006e9b09d16f8193b1 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/hex-0.4.3/src/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../hex/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../hex/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
</pre><pre class="rust"><code><span class="kw">use </span>core::fmt;
<span class="doccomment">/// The error type for decoding a hex string into `Vec&lt;u8&gt;` or `[u8; N]`.
</span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq)]
</span><span class="kw">pub enum </span>FromHexError {
<span class="doccomment">/// An invalid character was found. Valid ones are: `0...9`, `a...f`
/// or `A...F`.
</span>InvalidHexCharacter { c: char, index: usize },
<span class="doccomment">/// A hex string&#39;s length needs to be even, as two digits correspond to
/// one byte.
</span>OddLength,
<span class="doccomment">/// If the hex string is decoded into a fixed sized container, such as an
/// array, the hex string&#39;s length * 2 has to match the container&#39;s
/// length.
</span>InvalidStringLength,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>FromHexError {}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>FromHexError {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
FromHexError::InvalidHexCharacter { c, index } =&gt; {
<span class="macro">write!</span>(f, <span class="string">&quot;Invalid character {:?} at position {}&quot;</span>, c, index)
}
FromHexError::OddLength =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;Odd number of digits&quot;</span>),
FromHexError::InvalidStringLength =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;Invalid string length&quot;</span>),
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="comment">// this feature flag is here to suppress unused
// warnings of `super::*` and `pretty_assertions::assert_eq`
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">use </span>alloc::string::ToString;
<span class="kw">use </span>pretty_assertions::assert_eq;
<span class="attribute">#[test]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">fn </span>test_display() {
<span class="macro">assert_eq!</span>(
FromHexError::InvalidHexCharacter { c: <span class="string">&#39;\n&#39;</span>, index: <span class="number">5 </span>}.to_string(),
<span class="string">&quot;Invalid character &#39;\\n&#39; at position 5&quot;
</span>);
<span class="macro">assert_eq!</span>(FromHexError::OddLength.to_string(), <span class="string">&quot;Odd number of digits&quot;</span>);
<span class="macro">assert_eq!</span>(
FromHexError::InvalidStringLength.to_string(),
<span class="string">&quot;Invalid string length&quot;
</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hex" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>