Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+9
-10
@@ -1,15 +1,15 @@
|
||||
<!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="Configs"><meta name="keywords" content="rust, rustlang, rust-lang, base64"><title>base64 - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<!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 `base64` crate."><meta name="keywords" content="rust, rustlang, rust-lang, base64"><title>base64 - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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='../base64/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate base64</p><div class="block version"><p>Version 0.13.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all base64's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="base64" data-ty="mod" data-relpath="../"></div></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<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">Crate <a class="mod" href="">base64</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/base64/lib.rs.html#1-245" title="goto source code">[src]</a></span></h1><div class="docblock"><h1 id="configs" class="section-header"><a href="#configs">Configs</a></h1>
|
||||
<p>There isn’t just one type of Base64; that would be too simple. You need to choose a character
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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='../base64/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate base64</p><div class="block version"><p>Version 0.13.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all base64's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "base64", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<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="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/base64/lib.rs.html#1-245" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">base64</a></span></h1><div class="docblock"><h1 id="configs" class="section-header"><a href="#configs">Configs</a></h1>
|
||||
<p>There isn't just one type of Base64; that would be too simple. You need to choose a character
|
||||
set (standard, URL-safe, etc) and padding suffix (yes/no).
|
||||
The <code>Config</code> struct encapsulates this info. There are some common configs included: <code>STANDARD</code>,
|
||||
<code>URL_SAFE</code>, etc. You can also make your own <code>Config</code> if needed.</p>
|
||||
<p>The functions that don’t have <code>config</code> in the name (e.g. <code>encode()</code> and <code>decode()</code>) use the
|
||||
<p>The functions that don't have <code>config</code> in the name (e.g. <code>encode()</code> and <code>decode()</code>) use the
|
||||
<code>STANDARD</code> config .</p>
|
||||
<p>The functions that write to a slice (the ones that end in <code>_slice</code>) are generally the fastest
|
||||
because they don’t need to resize anything. If it fits in your workflow and you care about
|
||||
because they don't need to resize anything. If it fits in your workflow and you care about
|
||||
performance, keep using the same buffer (growing as need be) and use the <code>_slice</code> methods for
|
||||
the best performance.</p>
|
||||
<h1 id="encoding" class="section-header"><a href="#encoding">Encoding</a></h1>
|
||||
@@ -37,13 +37,13 @@ valid, but excess padding is not.) Whitespace in the input is invalid.</p>
|
||||
<p>To map a <code>Read</code> of b64 bytes to the decoded bytes, wrap a reader (file, network socket, etc)
|
||||
with <code>base64::read::DecoderReader</code>. To write raw bytes and have them b64 encoded on the fly,
|
||||
wrap a writer with <code>base64::write::EncoderWriter</code>. There is some performance overhead (15% or
|
||||
so) because of the necessary buffer shuffling – still fast enough that almost nobody cares.
|
||||
so) because of the necessary buffer shuffling -- still fast enough that almost nobody cares.
|
||||
Also, these implementations do not heap allocate.</p>
|
||||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||||
<p>If length calculations result in overflowing <code>usize</code>, a panic will result.</p>
|
||||
<p>The <code>_slice</code> flavors of encode or decode will panic if the provided output slice is too small,</p>
|
||||
</div><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||||
<table><tr class="module-item"><td><a class="mod" href="display/index.html" title="base64::display mod">display</a></td><td class="docblock-short"><p>Enables base64’d output anywhere you might use a <code>Display</code> implementation, like a format string.</p>
|
||||
<table><tr class="module-item"><td><a class="mod" href="display/index.html" title="base64::display mod">display</a></td><td class="docblock-short"><p>Enables base64'd output anywhere you might use a <code>Display</code> implementation, like a format string.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="mod" href="read/index.html" title="base64::read mod">read</a></td><td class="docblock-short"><p>Implementations of <code>io::Read</code> to transparently decode base64.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="mod" href="write/index.html" title="base64::write mod">write</a></td><td class="docblock-short"><p>Implementations of <code>io::Write</code> to transparently handle base64.</p>
|
||||
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||||
@@ -79,5 +79,4 @@ Returns a String.</p>
|
||||
Writes into the supplied output buffer, which will grow the buffer if needed.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="fn" href="fn.encode_config_slice.html" title="base64::encode_config_slice fn">encode_config_slice</a></td><td class="docblock-short"><p>Encode arbitrary octets as base64.
|
||||
Writes into the supplied output buffer.</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="base64"></div>
|
||||
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "base64";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user