trait.FromHex.html 12 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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="API documentation for the Rust `FromHex` trait in crate `rustc_serialize`."><meta name="keywords" content="rust, rustlang, rust-lang, FromHex"><title>rustc_serialize::hex::FromHex - Rust</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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[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">&#9776;</div><a href='../../rustc_serialize/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Trait FromHex</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_hex">from_hex</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-FromHex">str</a><a href="#impl-FromHex">&amp;&#39;a T</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>rustc_serialize</a>::<wbr><a href='index.html'>hex</a></p><script>window.sidebarCurrent = {name: 'FromHex', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>rustc_serialize</a>::<wbr><a href='index.html'>hex</a>::<wbr><a class="trait" href=''>FromHex</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#63-67' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait FromHex {
  2. fn <a href='#tymethod.from_hex' class='fnname'>from_hex</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;, <a class="enum" href="../../rustc_serialize/hex/enum.FromHexError.html" title="enum rustc_serialize::hex::FromHexError">FromHexError</a>&gt;;
  3. }</pre></div><div class='docblock'><p>A trait for converting hexadecimal encoded values</p>
  4. </div>
  5. <h2 id='required-methods' class='small-section-header'>
  6. Required Methods<a href='#required-methods' class='anchor'></a>
  7. </h2>
  8. <div class='methods'>
  9. <h3 id='tymethod.from_hex' class='method'><span id='from_hex.v' class='invisible'><code>fn <a href='#tymethod.from_hex' class='fnname'>from_hex</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;, <a class="enum" href="../../rustc_serialize/hex/enum.FromHexError.html" title="enum rustc_serialize::hex::FromHexError">FromHexError</a>&gt;</code></span></h3><div class='docblock'><p>Converts the value of <code>self</code>, interpreted as hexadecimal encoded data,
  10. into an owned vector of bytes, returning the vector.</p>
  11. </div></div>
  12. <h2 id='foreign-impls' class='small-section-header'>
  13. Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
  14. </h2>
  15. <h3 id='impl-FromHex' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../rustc_serialize/hex/trait.FromHex.html" title="trait rustc_serialize::hex::FromHex">FromHex</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-FromHex' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#103-162' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.from_hex' class="method"><span id='from_hex.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.from_hex' class='fnname'>from_hex</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;, <a class="enum" href="../../rustc_serialize/hex/enum.FromHexError.html" title="enum rustc_serialize::hex::FromHexError">FromHexError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#127-161' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert any hexadecimal encoded string (literal, <code>@</code>, <code>&amp;</code>, or <code>~</code>)
  16. to the byte values it encodes.</p>
  17. <p>You can use the <code>String::from_utf8</code> function to turn a
  18. <code>Vec&lt;u8&gt;</code> into a string with characters corresponding to those values.</p>
  19. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  20. <p>This converts a string literal to hexadecimal and back.</p>
  21. <pre class="rust rust-example-rendered">
  22. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
  23. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">hex</span>::{<span class="ident">FromHex</span>, <span class="ident">ToHex</span>};
  24. <span class="kw">fn</span> <span class="ident">main</span> () {
  25. <span class="kw">let</span> <span class="ident">hello_str</span> <span class="op">=</span> <span class="string">&quot;Hello, World&quot;</span>.<span class="ident">as_bytes</span>().<span class="ident">to_hex</span>();
  26. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">hello_str</span>);
  27. <span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="ident">hello_str</span>.<span class="ident">from_hex</span>().<span class="ident">unwrap</span>();
  28. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">bytes</span>);
  29. <span class="kw">let</span> <span class="ident">result_str</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from_utf8</span>(<span class="ident">bytes</span>).<span class="ident">unwrap</span>();
  30. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">result_str</span>);
  31. }</pre>
  32. </div></div></span><h3 id='impl-FromHex-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T:&nbsp;?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../rustc_serialize/hex/trait.FromHex.html" title="trait rustc_serialize::hex::FromHex">FromHex</a>&gt; <a class="trait" href="../../rustc_serialize/hex/trait.FromHex.html" title="trait rustc_serialize::hex::FromHex">FromHex</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T</code><a href='#impl-FromHex-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#164-168' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.from_hex-1' class="method"><span id='from_hex.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.from_hex' class='fnname'>from_hex</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;, <a class="enum" href="../../rustc_serialize/hex/enum.FromHexError.html" title="enum rustc_serialize::hex::FromHexError">FromHexError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#165-167' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
  33. <h2 id='implementors' class='small-section-header'>
  34. Implementors<a href='#implementors' class='anchor'></a>
  35. </h2>
  36. <ul class='item-list' id='implementors-list'>
  37. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  38. src="../../implementors/rustc_serialize/hex/trait.FromHex.js">
  39. </script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "rustc_serialize";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>