trait.ToBase64.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  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 `ToBase64` trait in crate `rustc_serialize`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, ToBase64">
  9. <title>rustc_serialize::base64::ToBase64 - 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 ToBase64</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.to_base64">to_base64</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ToBase64">[u8]</a><a href="#impl-ToBase64">&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'>base64</a></p><script>window.sidebarCurrent = {name: 'ToBase64', 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'>base64</a>::<wbr><a class="trait" href=''>ToBase64</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/base64.rs.html#73-77' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait ToBase64 {
  53. fn <a href='#tymethod.to_base64' class='fnname'>to_base64</a>(&amp;self, config: <a class="struct" href="../../rustc_serialize/base64/struct.Config.html" title="struct rustc_serialize::base64::Config">Config</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>;
  54. }</pre><div class='docblock'><p>A trait for converting a value to base64 encoding.</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.to_base64' class='method'><span id='to_base64.v' class='invisible'><code>fn <a href='#tymethod.to_base64' class='fnname'>to_base64</a>(&amp;self, config: <a class="struct" href="../../rustc_serialize/base64/struct.Config.html" title="struct rustc_serialize::base64::Config">Config</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></h3><div class='docblock'><p>Converts the value of <code>self</code> to a base64 value following the specified
  61. format configuration, returning the owned string.</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-ToBase64' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rustc_serialize/base64/trait.ToBase64.html" title="trait rustc_serialize::base64::ToBase64">ToBase64</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a href='#impl-ToBase64' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#79-192' title='goto source code'>[src]</a></span></h3>
  67. <span class='docblock autohide'><div class='impl-items'><h4 id='method.to_base64' class="method"><span id='to_base64.v-1' class='invisible'><code>fn <a href='#method.to_base64' class='fnname'>to_base64</a>(&amp;self, config: <a class="struct" href="../../rustc_serialize/base64/struct.Config.html" title="struct rustc_serialize::base64::Config">Config</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#93-191' title='goto source code'>[src]</a></span></h4>
  68. <div class='docblock'><p>Turn a vector of <code>u8</code> bytes into a base64 string.</p>
  69. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  70. <pre class="rust rust-example-rendered">
  71. <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
  72. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">base64</span>::{<span class="ident">ToBase64</span>, <span class="ident">STANDARD</span>};
  73. <span class="kw">fn</span> <span class="ident">main</span> () {
  74. <span class="kw">let</span> <span class="ident">str</span> <span class="op">=</span> [<span class="number">52</span>,<span class="number">32</span>].<span class="ident">to_base64</span>(<span class="ident">STANDARD</span>);
  75. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;base 64 output: {:?}&quot;</span>, <span class="ident">str</span>);
  76. }</pre>
  77. </div></div></span><h3 id='impl-ToBase64-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/base64/trait.ToBase64.html" title="trait rustc_serialize::base64::ToBase64">ToBase64</a>&gt; <a class="trait" href="../../rustc_serialize/base64/trait.ToBase64.html" title="trait rustc_serialize::base64::ToBase64">ToBase64</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T</code><a href='#impl-ToBase64-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#194-198' title='goto source code'>[src]</a></span></h3>
  78. <span class='docblock autohide'><div class='impl-items'><h4 id='method.to_base64-1' class="method"><span id='to_base64.v-2' class='invisible'><code>fn <a href='#method.to_base64' class='fnname'>to_base64</a>(&amp;self, config: <a class="struct" href="../../rustc_serialize/base64/struct.Config.html" title="struct rustc_serialize::base64::Config">Config</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#195-197' title='goto source code'>[src]</a></span></h4>
  79. </div></span>
  80. <h2 id='implementors' class='small-section-header'>
  81. Implementors<a href='#implementors' class='anchor'></a>
  82. </h2>
  83. <ul class='item-list' id='implementors-list'>
  84. </ul><script type="text/javascript" async
  85. src="../../implementors/rustc_serialize/base64/trait.ToBase64.js">
  86. </script></section>
  87. <section id='search' class="content hidden"></section>
  88. <section class="footer"></section>
  89. <aside id="help" class="hidden">
  90. <div>
  91. <h1 class="hidden">Help</h1>
  92. <div class="shortcuts">
  93. <h2>Keyboard Shortcuts</h2>
  94. <dl>
  95. <dt><kbd>?</kbd></dt>
  96. <dd>Show this help dialog</dd>
  97. <dt><kbd>S</kbd></dt>
  98. <dd>Focus the search field</dd>
  99. <dt><kbd>↑</kbd></dt>
  100. <dd>Move up in search results</dd>
  101. <dt><kbd>↓</kbd></dt>
  102. <dd>Move down in search results</dd>
  103. <dt><kbd>↹</kbd></dt>
  104. <dd>Switch tab</dd>
  105. <dt><kbd>&#9166;</kbd></dt>
  106. <dd>Go to active search result</dd>
  107. <dt><kbd>+</kbd></dt>
  108. <dd>Expand all sections</dd>
  109. <dt><kbd>-</kbd></dt>
  110. <dd>Collapse all sections</dd>
  111. </dl>
  112. </div>
  113. <div class="infos">
  114. <h2>Search Tricks</h2>
  115. <p>
  116. Prefix searches with a type followed by a colon (e.g.
  117. <code>fn:</code>) to restrict the search to a given type.
  118. </p>
  119. <p>
  120. Accepted types are: <code>fn</code>, <code>mod</code>,
  121. <code>struct</code>, <code>enum</code>,
  122. <code>trait</code>, <code>type</code>, <code>macro</code>,
  123. and <code>const</code>.
  124. </p>
  125. <p>
  126. Search functions by type signature (e.g.
  127. <code>vec -> usize</code> or <code>* -> vec</code>)
  128. </p>
  129. </div>
  130. </div>
  131. </aside>
  132. <script>
  133. window.rootPath = "../../";
  134. window.currentCrate = "rustc_serialize";
  135. </script>
  136. <script src="../../main.js"></script>
  137. <script defer src="../../search-index.js"></script>
  138. </body>
  139. </html>