<!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 `src\serde\base64.rs`."><title>base64.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><script id="default-settings"
data-use_system_theme="false"
data-theme="trash"></script><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="trash_utilities" data-themes="trash" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (b925a865e 2025-10-09)" data-channel="nightly" data-search-js="search-8d3311b9.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">trash_utilities\serde/</div>base64.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">/// Encode data as base64 string.
<a href=#2 id=2 data-nosnippet>2</a>///
<a href=#3 id=3 data-nosnippet>3</a>/// This function encodes binary data to a base64 string using standard encoding.
<a href=#4 id=4 data-nosnippet>4</a>/// Useful for transmitting binary data over text-based protocols.
<a href=#5 id=5 data-nosnippet>5</a>///
<a href=#6 id=6 data-nosnippet>6</a>/// # Parameters
<a href=#7 id=7 data-nosnippet>7</a>/// - `data`: The binary data to encode.
<a href=#8 id=8 data-nosnippet>8</a>///
<a href=#9 id=9 data-nosnippet>9</a>/// # Returns
<a href=#10 id=10 data-nosnippet>10</a>/// A base64-encoded string.
<a href=#11 id=11 data-nosnippet>11</a>///
<a href=#12 id=12 data-nosnippet>12</a>/// # Examples
<a href=#13 id=13 data-nosnippet>13</a>/// ```rust
<a href=#14 id=14 data-nosnippet>14</a>/// use trash_analyzer::serde::encode_base64;
<a href=#15 id=15 data-nosnippet>15</a>///
<a href=#16 id=16 data-nosnippet>16</a>/// let data = b"Hello, world!";
<a href=#17 id=17 data-nosnippet>17</a>/// let encoded = encode_base64(data);
<a href=#18 id=18 data-nosnippet>18</a>/// println!("Base64: {}", encoded);
<a href=#19 id=19 data-nosnippet>19</a>/// ```
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#[must_use]
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">pub fn </span>encode_base64(data: <span class="kw-2">&</span>[u8]) -> String {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">crate</span>::common::encode_base64(data)
<a href=#23 id=23 data-nosnippet>23</a>}
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="doccomment">/// Decode a base64 string to binary data.
<a href=#26 id=26 data-nosnippet>26</a>///
<a href=#27 id=27 data-nosnippet>27</a>/// This function decodes a base64 string back to binary data.
<a href=#28 id=28 data-nosnippet>28</a>/// Returns an error if the input is not valid base64.
<a href=#29 id=29 data-nosnippet>29</a>///
<a href=#30 id=30 data-nosnippet>30</a>/// # Parameters
<a href=#31 id=31 data-nosnippet>31</a>/// - `data`: The base64 string to decode.
<a href=#32 id=32 data-nosnippet>32</a>///
<a href=#33 id=33 data-nosnippet>33</a>/// # Returns
<a href=#34 id=34 data-nosnippet>34</a>/// - `Ok(Vec<u8>)` containing the decoded bytes.
<a href=#35 id=35 data-nosnippet>35</a>/// - `Err(base64::DecodeError)` if decoding fails.
<a href=#36 id=36 data-nosnippet>36</a>///
<a href=#37 id=37 data-nosnippet>37</a>/// # Errors
<a href=#38 id=38 data-nosnippet>38</a>/// Returns `base64::DecodeError` if the input string is not valid base64.
<a href=#39 id=39 data-nosnippet>39</a>///
<a href=#40 id=40 data-nosnippet>40</a>/// # Examples
<a href=#41 id=41 data-nosnippet>41</a>/// ```rust
<a href=#42 id=42 data-nosnippet>42</a>/// use trash_analyzer::serde::{encode_base64, decode_base64};
<a href=#43 id=43 data-nosnippet>43</a>///
<a href=#44 id=44 data-nosnippet>44</a>/// let data = b"Hello, world!";
<a href=#45 id=45 data-nosnippet>45</a>/// let encoded = encode_base64(data);
<a href=#46 id=46 data-nosnippet>46</a>/// let decoded = decode_base64(&encoded).unwrap();
<a href=#47 id=47 data-nosnippet>47</a>/// assert_eq!(decoded, data);
<a href=#48 id=48 data-nosnippet>48</a>/// ```
<a href=#49 id=49 data-nosnippet>49</a></span><span class="kw">pub fn </span>decode_base64(data: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><Vec<u8>, base64::DecodeError> {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">crate</span>::common::decode_base64(data)
<a href=#51 id=51 data-nosnippet>51</a>}
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a><span class="doccomment">/// Serialize a value to JSON and encode it as base64.
<a href=#54 id=54 data-nosnippet>54</a>///
<a href=#55 id=55 data-nosnippet>55</a>/// This convenience function serializes a value to JSON bytes and then
<a href=#56 id=56 data-nosnippet>56</a>/// encodes those bytes as base64. Useful for embedding structured data
<a href=#57 id=57 data-nosnippet>57</a>/// in text formats like JSON or XML.
<a href=#58 id=58 data-nosnippet>58</a>///
<a href=#59 id=59 data-nosnippet>59</a>/// # Type Parameters
<a href=#60 id=60 data-nosnippet>60</a>/// - `T`: The type to serialize, must implement `Serialize`.
<a href=#61 id=61 data-nosnippet>61</a>///
<a href=#62 id=62 data-nosnippet>62</a>/// # Parameters
<a href=#63 id=63 data-nosnippet>63</a>/// - `value`: The value to serialize and encode.
<a href=#64 id=64 data-nosnippet>64</a>///
<a href=#65 id=65 data-nosnippet>65</a>/// # Returns
<a href=#66 id=66 data-nosnippet>66</a>/// - `Ok(String)` containing the base64-encoded JSON.
<a href=#67 id=67 data-nosnippet>67</a>/// - `Err(serde_json::Error)` if serialization fails.
<a href=#68 id=68 data-nosnippet>68</a>///
<a href=#69 id=69 data-nosnippet>69</a>/// # Errors
<a href=#70 id=70 data-nosnippet>70</a>/// Returns `serde_json::Error` if the value cannot be serialized to JSON.
<a href=#71 id=71 data-nosnippet>71</a>///
<a href=#72 id=72 data-nosnippet>72</a>/// # Examples
<a href=#73 id=73 data-nosnippet>73</a>/// ```rust
<a href=#74 id=74 data-nosnippet>74</a>/// use trash_analyzer::serde::serialize_to_base64_json;
<a href=#75 id=75 data-nosnippet>75</a>/// use serde::Serialize;
<a href=#76 id=76 data-nosnippet>76</a>///
<a href=#77 id=77 data-nosnippet>77</a>/// #[derive(Serialize)]
<a href=#78 id=78 data-nosnippet>78</a>/// struct Person { name: String, age: u32 }
<a href=#79 id=79 data-nosnippet>79</a>///
<a href=#80 id=80 data-nosnippet>80</a>/// let person = Person { name: "Alice".to_string(), age: 30 };
<a href=#81 id=81 data-nosnippet>81</a>/// let b64_json = serialize_to_base64_json(&person).unwrap();
<a href=#82 id=82 data-nosnippet>82</a>/// println!("Base64 JSON: {}", b64_json);
<a href=#83 id=83 data-nosnippet>83</a>/// ```
<a href=#84 id=84 data-nosnippet>84</a></span><span class="kw">pub fn </span>serialize_to_base64_json<T: serde::Serialize>(
<a href=#85 id=85 data-nosnippet>85</a> value: <span class="kw-2">&</span>T,
<a href=#86 id=86 data-nosnippet>86</a>) -> <span class="prelude-ty">Result</span><String, serde_json::Error> {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span>bytes = serde_json::to_vec(value)<span class="question-mark">?</span>;
<a href=#88 id=88 data-nosnippet>88</a> <span class="prelude-val">Ok</span>(encode_base64(<span class="kw-2">&</span>bytes))
<a href=#89 id=89 data-nosnippet>89</a>}
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a><span class="doccomment">/// Decode base64 JSON and deserialize to a struct.
<a href=#92 id=92 data-nosnippet>92</a>///
<a href=#93 id=93 data-nosnippet>93</a>/// This function decodes a base64 string to JSON bytes and then deserializes
<a href=#94 id=94 data-nosnippet>94</a>/// those bytes into a struct. The inverse of `serialize_to_base64_json`.
<a href=#95 id=95 data-nosnippet>95</a>///
<a href=#96 id=96 data-nosnippet>96</a>/// # Type Parameters
<a href=#97 id=97 data-nosnippet>97</a>/// - `T`: The type to deserialize into, must implement `DeserializeOwned`.
<a href=#98 id=98 data-nosnippet>98</a>///
<a href=#99 id=99 data-nosnippet>99</a>/// # Parameters
<a href=#100 id=100 data-nosnippet>100</a>/// - `b64_json`: The base64-encoded JSON string.
<a href=#101 id=101 data-nosnippet>101</a>///
<a href=#102 id=102 data-nosnippet>102</a>/// # Returns
<a href=#103 id=103 data-nosnippet>103</a>/// - `Ok(T)` containing the deserialized value.
<a href=#104 id=104 data-nosnippet>104</a>/// - `Err(Box<dyn std::error::Error>)` if decoding or deserialization fails.
<a href=#105 id=105 data-nosnippet>105</a>///
<a href=#106 id=106 data-nosnippet>106</a>/// # Errors
<a href=#107 id=107 data-nosnippet>107</a>/// Returns an error if the base64 string is invalid or if the decoded JSON cannot be deserialized into the target type.
<a href=#108 id=108 data-nosnippet>108</a>///
<a href=#109 id=109 data-nosnippet>109</a>/// # Examples
<a href=#110 id=110 data-nosnippet>110</a>/// ```rust
<a href=#111 id=111 data-nosnippet>111</a>/// use trash_analyzer::serde::{serialize_to_base64_json, deserialize_from_base64_json};
<a href=#112 id=112 data-nosnippet>112</a>/// use serde::{Serialize, Deserialize};
<a href=#113 id=113 data-nosnippet>113</a>///
<a href=#114 id=114 data-nosnippet>114</a>/// #[derive(Serialize, Deserialize, Debug, PartialEq)]
<a href=#115 id=115 data-nosnippet>115</a>/// struct Person { name: String, age: u32 }
<a href=#116 id=116 data-nosnippet>116</a>///
<a href=#117 id=117 data-nosnippet>117</a>/// let person = Person { name: "Alice".to_string(), age: 30 };
<a href=#118 id=118 data-nosnippet>118</a>/// let b64_json = serialize_to_base64_json(&person).unwrap();
<a href=#119 id=119 data-nosnippet>119</a>/// let decoded: Person = deserialize_from_base64_json(&b64_json).unwrap();
<a href=#120 id=120 data-nosnippet>120</a>/// assert_eq!(decoded, person);
<a href=#121 id=121 data-nosnippet>121</a>/// ```
<a href=#122 id=122 data-nosnippet>122</a></span><span class="kw">pub fn </span>deserialize_from_base64_json<T: <span class="kw">for</span><<span class="lifetime">'de</span>> serde::Deserialize<<span class="lifetime">'de</span>>>(
<a href=#123 id=123 data-nosnippet>123</a> b64_json: <span class="kw-2">&</span>str,
<a href=#124 id=124 data-nosnippet>124</a>) -> <span class="prelude-ty">Result</span><T, Box<<span class="kw">dyn </span>std::error::Error>> {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span>bytes = decode_base64(b64_json)<span class="question-mark">?</span>;
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>value: T = serde_json::from_slice(<span class="kw-2">&</span>bytes)<span class="question-mark">?</span>;
<a href=#127 id=127 data-nosnippet>127</a> <span class="prelude-val">Ok</span>(value)
<a href=#128 id=128 data-nosnippet>128</a>}</code></pre></div></section></main></body></html>