176 lines
15 KiB
HTML
176 lines
15 KiB
HTML
|
<!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 `FromBase64` trait in crate `rustc_serialize`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, FromBase64">
|
|||
|
|
|
|||
|
|
<title>rustc_serialize::base64::FromBase64 - 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="../../main.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">☰</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 FromBase64</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_base64">from_base64</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-FromBase64">str</a><a href="#impl-FromBase64">[u8]</a><a href="#impl-FromBase64">&'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: 'FromBase64', 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">
|
|||
|
|
</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'>base64</a>::<wbr><a class="trait" href=''>FromBase64</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#201-205' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait FromBase64 {
|
|||
|
|
fn <a href='#tymethod.from_base64' class='fnname'>from_base64</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="enum" href="../../rustc_serialize/base64/enum.FromBase64Error.html" title="enum rustc_serialize::base64::FromBase64Error">FromBase64Error</a>>;
|
|||
|
|
}</pre><div class='docblock'><p>A trait for converting from base64 encoded values.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.from_base64' class='method'><span id='from_base64.v' class='invisible'><code>fn <a href='#tymethod.from_base64' class='fnname'>from_base64</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="enum" href="../../rustc_serialize/base64/enum.FromBase64Error.html" title="enum rustc_serialize::base64::FromBase64Error">FromBase64Error</a>></code></span></h3><div class='docblock'><p>Converts the value of <code>self</code>, interpreted as base64 encoded data, into
|
|||
|
|
an owned vector of bytes, returning the vector.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-FromBase64' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rustc_serialize/base64/trait.FromBase64.html" title="trait rustc_serialize::base64::FromBase64">FromBase64</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-FromBase64' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#241-272' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.from_base64' class="method"><span id='from_base64.v-1' class='invisible'><code>fn <a href='#method.from_base64' class='fnname'>from_base64</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="enum" href="../../rustc_serialize/base64/enum.FromBase64Error.html" title="enum rustc_serialize::base64::FromBase64Error">FromBase64Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#269-271' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Convert any base64 encoded string (literal, <code>@</code>, <code>&</code>, or <code>~</code>)
|
|||
|
|
to the byte values it encodes.</p>
|
|||
|
|
<p>You can use the <code>String::from_utf8</code> function to turn a <code>Vec<u8></code> into a
|
|||
|
|
string with characters corresponding to those values.</p>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<p>This converts a string literal to base64 and back.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">base64</span>::{<span class="ident">ToBase64</span>, <span class="ident">FromBase64</span>, <span class="ident">STANDARD</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span> () {
|
|||
|
|
<span class="kw">let</span> <span class="ident">hello_str</span> <span class="op">=</span> <span class="string">b"Hello, World"</span>.<span class="ident">to_base64</span>(<span class="ident">STANDARD</span>);
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"base64 output: {}"</span>, <span class="ident">hello_str</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">hello_str</span>.<span class="ident">from_base64</span>();
|
|||
|
|
<span class="kw">if</span> <span class="ident">res</span>.<span class="ident">is_ok</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">opt_bytes</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from_utf8</span>(<span class="ident">res</span>.<span class="ident">unwrap</span>());
|
|||
|
|
<span class="kw">if</span> <span class="ident">opt_bytes</span>.<span class="ident">is_ok</span>() {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"decoded from base64: {:?}"</span>, <span class="ident">opt_bytes</span>.<span class="ident">unwrap</span>());
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}</pre>
|
|||
|
|
</div></div></span><h3 id='impl-FromBase64-1' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rustc_serialize/base64/trait.FromBase64.html" title="trait rustc_serialize::base64::FromBase64">FromBase64</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-FromBase64-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#274-324' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.from_base64-1' class="method"><span id='from_base64.v-2' class='invisible'><code>fn <a href='#method.from_base64' class='fnname'>from_base64</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="enum" href="../../rustc_serialize/base64/enum.FromBase64Error.html" title="enum rustc_serialize::base64::FromBase64Error">FromBase64Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#275-323' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span><h3 id='impl-FromBase64-2' class='impl'><span class='in-band'><code>impl<'a, T: ?<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.FromBase64.html" title="trait rustc_serialize::base64::FromBase64">FromBase64</a>> <a class="trait" href="../../rustc_serialize/base64/trait.FromBase64.html" title="trait rustc_serialize::base64::FromBase64">FromBase64</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T</code><a href='#impl-FromBase64-2' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#326-330' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<span class='docblock autohide'><div class='impl-items'><h4 id='method.from_base64-2' class="method"><span id='from_base64.v-3' class='invisible'><code>fn <a href='#method.from_base64' class='fnname'>from_base64</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, <a class="enum" href="../../rustc_serialize/base64/enum.FromBase64Error.html" title="enum rustc_serialize::base64::FromBase64Error">FromBase64Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustc_serialize/base64.rs.html#327-329' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></span>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/rustc_serialize/base64/trait.FromBase64.js">
|
|||
|
|
</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>⏎</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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "rustc_serialize";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|