trait.FromHex.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `FromHex` trait in crate `rustc_serialize`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, FromHex">
  9. <title>rustc_serialize::hex::FromHex - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
  16. </head>
  17. <body class="rustdoc trait">
  18. <!--[if lte IE 8]>
  19. <div class="warning">
  20. This old browser is unsupported and will most likely display funky
  21. things.
  22. </div>
  23. <![endif]-->
  24. <nav class="sidebar">
  25. <div class="sidebar-menu">&#9776;</div>
  26. <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>
  27. <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>
  28. </nav>
  29. <div class="theme-picker">
  30. <button id="theme-picker" aria-label="Pick another theme!">
  31. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  32. </button>
  33. <div id="theme-choices"></div>
  34. </div>
  35. <script src="../../theme.js"></script>
  36. <nav class="sub">
  37. <form class="search-form js-only">
  38. <div class="search-container">
  39. <input class="search-input" name="search"
  40. autocomplete="off"
  41. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  42. type="search">
  43. </div>
  44. </form>
  45. </nav>
  46. <section id='main' class="content">
  47. <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'>
  48. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  49. [<span class='inner'>&#x2212;</span>]
  50. </a>
  51. </span><a class='srclink' href='../../src/rustc_serialize/hex.rs.html#63-67' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait FromHex {
  53. 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;;
  54. }</pre><div class='docblock'><p>A trait for converting hexadecimal encoded values</p>
  55. </div>
  56. <h2 id='required-methods' class='small-section-header'>
  57. Required Methods<a href='#required-methods' class='anchor'></a>
  58. </h2>
  59. <div class='methods'>
  60. <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,
  61. into an owned vector of bytes, returning the vector.</p>
  62. </div></div>
  63. <h2 id='foreign-impls' class='small-section-header'>
  64. Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
  65. </h2>
  66. <h3 id='impl-FromHex' class='impl'><span class='in-band'><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><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></h3>
  67. <span class='docblock autohide'><div class='impl-items'><h4 id='method.from_hex' class="method"><span id='from_hex.v-1' class='invisible'><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><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></span></h4>
  68. <div class='docblock'><p>Convert any hexadecimal encoded string (literal, <code>@</code>, <code>&amp;</code>, or <code>~</code>)
  69. to the byte values it encodes.</p>
  70. <p>You can use the <code>String::from_utf8</code> function to turn a
  71. <code>Vec&lt;u8&gt;</code> into a string with characters corresponding to those values.</p>
  72. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  73. <p>This converts a string literal to hexadecimal and back.</p>
  74. <pre class="rust rust-example-rendered">
  75. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
  76. <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>};
  77. <span class="kw">fn</span> <span class="ident">main</span> () {
  78. <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>();
  79. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">hello_str</span>);
  80. <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>();
  81. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:?}&quot;</span>, <span class="ident">bytes</span>);
  82. <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>();
  83. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">result_str</span>);
  84. }</pre>
  85. </div></div></span><h3 id='impl-FromHex-1' class='impl'><span class='in-band'><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><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></h3>
  86. <span class='docblock autohide'><div class='impl-items'><h4 id='method.from_hex-1' class="method"><span id='from_hex.v-2' class='invisible'><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><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></span></h4>
  87. </div></span>
  88. <h2 id='implementors' class='small-section-header'>
  89. Implementors<a href='#implementors' class='anchor'></a>
  90. </h2>
  91. <ul class='item-list' id='implementors-list'>
  92. </ul><script type="text/javascript" async
  93. src="../../implementors/rustc_serialize/hex/trait.FromHex.js">
  94. </script></section>
  95. <section id='search' class="content hidden"></section>
  96. <section class="footer"></section>
  97. <aside id="help" class="hidden">
  98. <div>
  99. <h1 class="hidden">Help</h1>
  100. <div class="shortcuts">
  101. <h2>Keyboard Shortcuts</h2>
  102. <dl>
  103. <dt><kbd>?</kbd></dt>
  104. <dd>Show this help dialog</dd>
  105. <dt><kbd>S</kbd></dt>
  106. <dd>Focus the search field</dd>
  107. <dt><kbd>↑</kbd></dt>
  108. <dd>Move up in search results</dd>
  109. <dt><kbd>↓</kbd></dt>
  110. <dd>Move down in search results</dd>
  111. <dt><kbd>↹</kbd></dt>
  112. <dd>Switch tab</dd>
  113. <dt><kbd>&#9166;</kbd></dt>
  114. <dd>Go to active search result</dd>
  115. <dt><kbd>+</kbd></dt>
  116. <dd>Expand all sections</dd>
  117. <dt><kbd>-</kbd></dt>
  118. <dd>Collapse all sections</dd>
  119. </dl>
  120. </div>
  121. <div class="infos">
  122. <h2>Search Tricks</h2>
  123. <p>
  124. Prefix searches with a type followed by a colon (e.g.
  125. <code>fn:</code>) to restrict the search to a given type.
  126. </p>
  127. <p>
  128. Accepted types are: <code>fn</code>, <code>mod</code>,
  129. <code>struct</code>, <code>enum</code>,
  130. <code>trait</code>, <code>type</code>, <code>macro</code>,
  131. and <code>const</code>.
  132. </p>
  133. <p>
  134. Search functions by type signature (e.g.
  135. <code>vec -> usize</code> or <code>* -> vec</code>)
  136. </p>
  137. </div>
  138. </div>
  139. </aside>
  140. <script>
  141. window.rootPath = "../../";
  142. window.currentCrate = "rustc_serialize";
  143. </script>
  144. <script src="../../main.js"></script>
  145. <script defer src="../../search-index.js"></script>
  146. </body>
  147. </html>