| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/base64-0.13.1/src/display.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>display.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../base64/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Enables base64'd output anywhere you might use a `Display` implementation, like a format string. |
| //! |
| //! ``` |
| //! use base64::display::Base64Display; |
| //! |
| //! let data = vec![0x0, 0x1, 0x2, 0x3]; |
| //! let wrapper = Base64Display::with_config(&data, base64::STANDARD); |
| //! |
| //! assert_eq!("base64: AAECAw==", format!("base64: {}", wrapper)); |
| //! ``` |
| |
| </span><span class="kw">use </span><span class="kw">super</span>::chunked_encoder::ChunkedEncoder; |
| <span class="kw">use </span><span class="kw">super</span>::Config; |
| <span class="kw">use </span>core::fmt::{Display, Formatter}; |
| <span class="kw">use </span>core::{fmt, str}; |
| |
| <span class="doccomment">/// A convenience wrapper for base64'ing bytes into a format string without heap allocation. |
| </span><span class="kw">pub struct </span>Base64Display<<span class="lifetime">'a</span>> { |
| bytes: <span class="kw-2">&</span><span class="lifetime">'a </span>[u8], |
| chunked_encoder: ChunkedEncoder, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Base64Display<<span class="lifetime">'a</span>> { |
| <span class="doccomment">/// Create a `Base64Display` with the provided config. |
| </span><span class="kw">pub fn </span>with_config(bytes: <span class="kw-2">&</span>[u8], config: Config) -> Base64Display { |
| Base64Display { |
| bytes, |
| chunked_encoder: ChunkedEncoder::new(config), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Display <span class="kw">for </span>Base64Display<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, formatter: <span class="kw-2">&mut </span>Formatter) -> <span class="prelude-ty">Result</span><(), fmt::Error> { |
| <span class="kw">let </span><span class="kw-2">mut </span>sink = FormatterSink { f: formatter }; |
| <span class="self">self</span>.chunked_encoder.encode(<span class="self">self</span>.bytes, <span class="kw-2">&mut </span>sink) |
| } |
| } |
| |
| <span class="kw">struct </span>FormatterSink<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>: <span class="lifetime">'a</span>> { |
| f: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Formatter<<span class="lifetime">'b</span>>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'b</span>: <span class="lifetime">'a</span>> <span class="kw">super</span>::chunked_encoder::Sink <span class="kw">for </span>FormatterSink<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="kw">type </span>Error = fmt::Error; |
| |
| <span class="kw">fn </span>write_encoded_bytes(<span class="kw-2">&mut </span><span class="self">self</span>, encoded: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><(), <span class="self">Self</span>::Error> { |
| <span class="comment">// Avoid unsafe. If max performance is needed, write your own display wrapper that uses |
| // unsafe here to gain about 10-15%. |
| </span><span class="self">self</span>.f |
| .write_str(str::from_utf8(encoded).expect(<span class="string">"base64 data was not utf8"</span>)) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::chunked_encoder::tests::{ |
| chunked_encode_matches_normal_encode_random, SinkTestHelper, |
| }; |
| <span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::<span class="kw-2">*</span>; |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>basic_display() { |
| <span class="macro">assert_eq!</span>( |
| <span class="string">"~$Zm9vYmFy#*"</span>, |
| <span class="macro">format!</span>(<span class="string">"~${}#*"</span>, Base64Display::with_config(<span class="string">b"foobar"</span>, STANDARD)) |
| ); |
| <span class="macro">assert_eq!</span>( |
| <span class="string">"~$Zm9vYmFyZg==#*"</span>, |
| <span class="macro">format!</span>(<span class="string">"~${}#*"</span>, Base64Display::with_config(<span class="string">b"foobarf"</span>, STANDARD)) |
| ); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>display_encode_matches_normal_encode() { |
| <span class="kw">let </span>helper = DisplaySinkTestHelper; |
| chunked_encode_matches_normal_encode_random(<span class="kw-2">&</span>helper); |
| } |
| |
| <span class="kw">struct </span>DisplaySinkTestHelper; |
| |
| <span class="kw">impl </span>SinkTestHelper <span class="kw">for </span>DisplaySinkTestHelper { |
| <span class="kw">fn </span>encode_to_string(<span class="kw-2">&</span><span class="self">self</span>, config: Config, bytes: <span class="kw-2">&</span>[u8]) -> String { |
| <span class="macro">format!</span>(<span class="string">"{}"</span>, Base64Display::with_config(bytes, config)) |
| } |
| } |
| } |
| </code></pre></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> |
