blob: 765772ce883e47e33fa7f6e3f04e005624cc21cd [file] [log] [blame]
<!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="Preconfigured engines for common use cases."><meta name="keywords" content="rust, rustlang, rust-lang, prelude"><title>base64::prelude - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../base64/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../base64/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module prelude</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">base64</a>::<wbr><a class="mod" href="#">prelude</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/base64/prelude.rs.html#1-19">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Preconfigured engines for common use cases.</p>
<p>These are re-exports of <code>const</code> engines in <a href="../engine/general_purpose/index.html" title="crate::engine::general_purpose">crate::engine::general_purpose</a>, renamed with a <code>BASE64_</code>
prefix for those who prefer to <code>use</code> the entire path to a name.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>base64::prelude::{Engine <span class="kw">as _</span>, BASE64_STANDARD_NO_PAD};
<span class="macro">assert_eq!</span>(<span class="string">&quot;c29tZSBieXRlcw&quot;</span>, <span class="kw-2">&amp;</span>BASE64_STANDARD_NO_PAD.encode(<span class="string">b&quot;some bytes&quot;</span>));</code></pre></div>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Engine"><code>pub use crate::engine::<a class="trait" href="../engine/trait.Engine.html" title="trait base64::engine::Engine">Engine</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.BASE64_STANDARD"><code>pub use crate::engine::general_purpose::<a class="constant" href="../engine/general_purpose/constant.STANDARD.html" title="constant base64::engine::general_purpose::STANDARD">STANDARD</a> as BASE64_STANDARD;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.BASE64_STANDARD_NO_PAD"><code>pub use crate::engine::general_purpose::<a class="constant" href="../engine/general_purpose/constant.STANDARD_NO_PAD.html" title="constant base64::engine::general_purpose::STANDARD_NO_PAD">STANDARD_NO_PAD</a> as BASE64_STANDARD_NO_PAD;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.BASE64_URL_SAFE"><code>pub use crate::engine::general_purpose::<a class="constant" href="../engine/general_purpose/constant.URL_SAFE.html" title="constant base64::engine::general_purpose::URL_SAFE">URL_SAFE</a> as BASE64_URL_SAFE;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.BASE64_URL_SAFE_NO_PAD"><code>pub use crate::engine::general_purpose::<a class="constant" href="../engine/general_purpose/constant.URL_SAFE_NO_PAD.html" title="constant base64::engine::general_purpose::URL_SAFE_NO_PAD">URL_SAFE_NO_PAD</a> as BASE64_URL_SAFE_NO_PAD;</code></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="base64" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>