Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions
+876
View File
@@ -0,0 +1,876 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/zeroize-1.8.2/src/lib.rs`."><title>lib.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"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zeroize" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.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-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.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">zeroize/</div>lib.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="attr">#![no_std]
<a href=#2 id=2 data-nosnippet>2</a>#![cfg_attr(docsrs, feature(doc_cfg))]
<a href=#3 id=3 data-nosnippet>3</a>#![doc(
<a href=#4 id=4 data-nosnippet>4</a> html_logo_url = <span class="string">"https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"</span>,
<a href=#5 id=5 data-nosnippet>5</a> html_favicon_url = <span class="string">"https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
<a href=#6 id=6 data-nosnippet>6</a></span>)]
<a href=#7 id=7 data-nosnippet>7</a>#![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a></span><span class="doccomment">//! Securely zero memory with a simple trait ([`Zeroize`]) built on stable Rust
<a href=#10 id=10 data-nosnippet>10</a>//! primitives which guarantee the operation will not be "optimized away".
<a href=#11 id=11 data-nosnippet>11</a>//!
<a href=#12 id=12 data-nosnippet>12</a>//! ## About
<a href=#13 id=13 data-nosnippet>13</a>//!
<a href=#14 id=14 data-nosnippet>14</a>//! [Zeroing memory securely is hard] - compilers optimize for performance, and
<a href=#15 id=15 data-nosnippet>15</a>//! in doing so they love to "optimize away" unnecessary zeroing calls. There are
<a href=#16 id=16 data-nosnippet>16</a>//! many documented "tricks" to attempt to avoid these optimizations and ensure
<a href=#17 id=17 data-nosnippet>17</a>//! that a zeroing routine is performed reliably.
<a href=#18 id=18 data-nosnippet>18</a>//!
<a href=#19 id=19 data-nosnippet>19</a>//! This crate isn't about tricks: it uses [`core::ptr::write_volatile`]
<a href=#20 id=20 data-nosnippet>20</a>//! and [`core::sync::atomic`] memory fences to provide easy-to-use, portable
<a href=#21 id=21 data-nosnippet>21</a>//! zeroing behavior which works on all of Rust's core number types and slices
<a href=#22 id=22 data-nosnippet>22</a>//! thereof, implemented in pure Rust with no usage of FFI or assembly.
<a href=#23 id=23 data-nosnippet>23</a>//!
<a href=#24 id=24 data-nosnippet>24</a>//! - No insecure fallbacks!
<a href=#25 id=25 data-nosnippet>25</a>//! - No dependencies!
<a href=#26 id=26 data-nosnippet>26</a>//! - No FFI or inline assembly! **WASM friendly** (and tested)!
<a href=#27 id=27 data-nosnippet>27</a>//! - `#![no_std]` i.e. **embedded-friendly**!
<a href=#28 id=28 data-nosnippet>28</a>//! - No functionality besides securely zeroing memory!
<a href=#29 id=29 data-nosnippet>29</a>//! - (Optional) Custom derive support for zeroing complex structures
<a href=#30 id=30 data-nosnippet>30</a>//!
<a href=#31 id=31 data-nosnippet>31</a>//! ## Minimum Supported Rust Version
<a href=#32 id=32 data-nosnippet>32</a>//!
<a href=#33 id=33 data-nosnippet>33</a>//! Requires Rust **1.72** or newer.
<a href=#34 id=34 data-nosnippet>34</a>//!
<a href=#35 id=35 data-nosnippet>35</a>//! In the future, we reserve the right to change MSRV (i.e. MSRV is out-of-scope
<a href=#36 id=36 data-nosnippet>36</a>//! for this crate's SemVer guarantees), however when we do it will be accompanied
<a href=#37 id=37 data-nosnippet>37</a>//! by a minor version bump.
<a href=#38 id=38 data-nosnippet>38</a>//!
<a href=#39 id=39 data-nosnippet>39</a>//! ## Usage
<a href=#40 id=40 data-nosnippet>40</a>//!
<a href=#41 id=41 data-nosnippet>41</a>//! ```
<a href=#42 id=42 data-nosnippet>42</a>//! use zeroize::Zeroize;
<a href=#43 id=43 data-nosnippet>43</a>//!
<a href=#44 id=44 data-nosnippet>44</a>//! // Protip: don't embed secrets in your source code.
<a href=#45 id=45 data-nosnippet>45</a>//! // This is just an example.
<a href=#46 id=46 data-nosnippet>46</a>//! let mut secret = b"Air shield password: 1,2,3,4,5".to_vec();
<a href=#47 id=47 data-nosnippet>47</a>//! // [ ... ] open the air shield here
<a href=#48 id=48 data-nosnippet>48</a>//!
<a href=#49 id=49 data-nosnippet>49</a>//! // Now that we're done using the secret, zero it out.
<a href=#50 id=50 data-nosnippet>50</a>//! secret.zeroize();
<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>//! The [`Zeroize`] trait is impl'd on all of Rust's core scalar types including
<a href=#54 id=54 data-nosnippet>54</a>//! integers, floats, `bool`, and `char`.
<a href=#55 id=55 data-nosnippet>55</a>//!
<a href=#56 id=56 data-nosnippet>56</a>//! Additionally, it's implemented on slices and `IterMut`s of the above types.
<a href=#57 id=57 data-nosnippet>57</a>//!
<a href=#58 id=58 data-nosnippet>58</a>//! When the `alloc` feature is enabled (which it is by default), it's also
<a href=#59 id=59 data-nosnippet>59</a>//! impl'd for `Vec&lt;T&gt;` for the above types as well as `String`, where it provides
<a href=#60 id=60 data-nosnippet>60</a>//! [`Vec::clear`] / [`String::clear`]-like behavior (truncating to zero-length)
<a href=#61 id=61 data-nosnippet>61</a>//! but ensures the backing memory is securely zeroed with some caveats.
<a href=#62 id=62 data-nosnippet>62</a>//!
<a href=#63 id=63 data-nosnippet>63</a>//! With the `std` feature enabled (which it is **not** by default), [`Zeroize`]
<a href=#64 id=64 data-nosnippet>64</a>//! is also implemented for [`CString`]. After calling `zeroize()` on a `CString`,
<a href=#65 id=65 data-nosnippet>65</a>//! its internal buffer will contain exactly one nul byte. The backing
<a href=#66 id=66 data-nosnippet>66</a>//! memory is zeroed by converting it to a `Vec&lt;u8&gt;` and back into a `CString`.
<a href=#67 id=67 data-nosnippet>67</a>//! (NOTE: see "Stack/Heap Zeroing Notes" for important `Vec`/`String`/`CString` details)
<a href=#68 id=68 data-nosnippet>68</a>//!
<a href=#69 id=69 data-nosnippet>69</a>//! [`CString`]: https://doc.rust-lang.org/std/ffi/struct.CString.html
<a href=#70 id=70 data-nosnippet>70</a>//!
<a href=#71 id=71 data-nosnippet>71</a>//! The [`DefaultIsZeroes`] marker trait can be impl'd on types which also
<a href=#72 id=72 data-nosnippet>72</a>//! impl [`Default`], which implements [`Zeroize`] by overwriting a value with
<a href=#73 id=73 data-nosnippet>73</a>//! the default value.
<a href=#74 id=74 data-nosnippet>74</a>//!
<a href=#75 id=75 data-nosnippet>75</a>//! ## Custom Derive Support
<a href=#76 id=76 data-nosnippet>76</a>//!
<a href=#77 id=77 data-nosnippet>77</a>//! This crate has custom derive support for the `Zeroize` trait,
<a href=#78 id=78 data-nosnippet>78</a>//! gated under the `zeroize` crate's `zeroize_derive` Cargo feature,
<a href=#79 id=79 data-nosnippet>79</a>//! which automatically calls `zeroize()` on all members of a struct
<a href=#80 id=80 data-nosnippet>80</a>//! or tuple struct.
<a href=#81 id=81 data-nosnippet>81</a>//!
<a href=#82 id=82 data-nosnippet>82</a>//! Attributes supported for `Zeroize`:
<a href=#83 id=83 data-nosnippet>83</a>//!
<a href=#84 id=84 data-nosnippet>84</a>//! On the item level:
<a href=#85 id=85 data-nosnippet>85</a>//! - `#[zeroize(drop)]`: *deprecated* use `ZeroizeOnDrop` instead
<a href=#86 id=86 data-nosnippet>86</a>//! - `#[zeroize(bound = "T: MyTrait")]`: this replaces any trait bounds
<a href=#87 id=87 data-nosnippet>87</a>//! inferred by zeroize
<a href=#88 id=88 data-nosnippet>88</a>//!
<a href=#89 id=89 data-nosnippet>89</a>//! On the field level:
<a href=#90 id=90 data-nosnippet>90</a>//! - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()`
<a href=#91 id=91 data-nosnippet>91</a>//!
<a href=#92 id=92 data-nosnippet>92</a>//! Attributes supported for `ZeroizeOnDrop`:
<a href=#93 id=93 data-nosnippet>93</a>//!
<a href=#94 id=94 data-nosnippet>94</a>//! On the field level:
<a href=#95 id=95 data-nosnippet>95</a>//! - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()`
<a href=#96 id=96 data-nosnippet>96</a>//!
<a href=#97 id=97 data-nosnippet>97</a>//! Example which derives `Drop`:
<a href=#98 id=98 data-nosnippet>98</a>//!
<a href=#99 id=99 data-nosnippet>99</a>//! ```
<a href=#100 id=100 data-nosnippet>100</a>//! # #[cfg(feature = "zeroize_derive")]
<a href=#101 id=101 data-nosnippet>101</a>//! # {
<a href=#102 id=102 data-nosnippet>102</a>//! use zeroize::{Zeroize, ZeroizeOnDrop};
<a href=#103 id=103 data-nosnippet>103</a>//!
<a href=#104 id=104 data-nosnippet>104</a>//! // This struct will be zeroized on drop
<a href=#105 id=105 data-nosnippet>105</a>//! #[derive(Zeroize, ZeroizeOnDrop)]
<a href=#106 id=106 data-nosnippet>106</a>//! struct MyStruct([u8; 32]);
<a href=#107 id=107 data-nosnippet>107</a>//! # }
<a href=#108 id=108 data-nosnippet>108</a>//! ```
<a href=#109 id=109 data-nosnippet>109</a>//!
<a href=#110 id=110 data-nosnippet>110</a>//! Example which does not derive `Drop` (useful for e.g. `Copy` types)
<a href=#111 id=111 data-nosnippet>111</a>//!
<a href=#112 id=112 data-nosnippet>112</a>//! ```
<a href=#113 id=113 data-nosnippet>113</a>//! #[cfg(feature = "zeroize_derive")]
<a href=#114 id=114 data-nosnippet>114</a>//! # {
<a href=#115 id=115 data-nosnippet>115</a>//! use zeroize::Zeroize;
<a href=#116 id=116 data-nosnippet>116</a>//!
<a href=#117 id=117 data-nosnippet>117</a>//! // This struct will *NOT* be zeroized on drop
<a href=#118 id=118 data-nosnippet>118</a>//! #[derive(Copy, Clone, Zeroize)]
<a href=#119 id=119 data-nosnippet>119</a>//! struct MyStruct([u8; 32]);
<a href=#120 id=120 data-nosnippet>120</a>//! # }
<a href=#121 id=121 data-nosnippet>121</a>//! ```
<a href=#122 id=122 data-nosnippet>122</a>//!
<a href=#123 id=123 data-nosnippet>123</a>//! Example which only derives `Drop`:
<a href=#124 id=124 data-nosnippet>124</a>//!
<a href=#125 id=125 data-nosnippet>125</a>//! ```
<a href=#126 id=126 data-nosnippet>126</a>//! # #[cfg(feature = "zeroize_derive")]
<a href=#127 id=127 data-nosnippet>127</a>//! # {
<a href=#128 id=128 data-nosnippet>128</a>//! use zeroize::ZeroizeOnDrop;
<a href=#129 id=129 data-nosnippet>129</a>//!
<a href=#130 id=130 data-nosnippet>130</a>//! // This struct will be zeroized on drop
<a href=#131 id=131 data-nosnippet>131</a>//! #[derive(ZeroizeOnDrop)]
<a href=#132 id=132 data-nosnippet>132</a>//! struct MyStruct([u8; 32]);
<a href=#133 id=133 data-nosnippet>133</a>//! # }
<a href=#134 id=134 data-nosnippet>134</a>//! ```
<a href=#135 id=135 data-nosnippet>135</a>//!
<a href=#136 id=136 data-nosnippet>136</a>//! ## `Zeroizing&lt;Z&gt;`: wrapper for zeroizing arbitrary values on drop
<a href=#137 id=137 data-nosnippet>137</a>//!
<a href=#138 id=138 data-nosnippet>138</a>//! `Zeroizing&lt;Z: Zeroize&gt;` is a generic wrapper type that impls `Deref`
<a href=#139 id=139 data-nosnippet>139</a>//! and `DerefMut`, allowing access to an inner value of type `Z`, and also
<a href=#140 id=140 data-nosnippet>140</a>//! impls a `Drop` handler which calls `zeroize()` on its contents:
<a href=#141 id=141 data-nosnippet>141</a>//!
<a href=#142 id=142 data-nosnippet>142</a>//! ```
<a href=#143 id=143 data-nosnippet>143</a>//! use zeroize::Zeroizing;
<a href=#144 id=144 data-nosnippet>144</a>//!
<a href=#145 id=145 data-nosnippet>145</a>//! fn use_secret() {
<a href=#146 id=146 data-nosnippet>146</a>//! let mut secret = Zeroizing::new([0u8; 5]);
<a href=#147 id=147 data-nosnippet>147</a>//!
<a href=#148 id=148 data-nosnippet>148</a>//! // Set the air shield password
<a href=#149 id=149 data-nosnippet>149</a>//! // Protip (again): don't embed secrets in your source code.
<a href=#150 id=150 data-nosnippet>150</a>//! secret.copy_from_slice(&amp;[1, 2, 3, 4, 5]);
<a href=#151 id=151 data-nosnippet>151</a>//! assert_eq!(secret.as_ref(), &amp;[1, 2, 3, 4, 5]);
<a href=#152 id=152 data-nosnippet>152</a>//!
<a href=#153 id=153 data-nosnippet>153</a>//! // The contents of `secret` will be automatically zeroized on drop
<a href=#154 id=154 data-nosnippet>154</a>//! }
<a href=#155 id=155 data-nosnippet>155</a>//!
<a href=#156 id=156 data-nosnippet>156</a>//! # use_secret()
<a href=#157 id=157 data-nosnippet>157</a>//! ```
<a href=#158 id=158 data-nosnippet>158</a>//!
<a href=#159 id=159 data-nosnippet>159</a>//! ## What guarantees does this crate provide?
<a href=#160 id=160 data-nosnippet>160</a>//!
<a href=#161 id=161 data-nosnippet>161</a>//! This crate guarantees the following:
<a href=#162 id=162 data-nosnippet>162</a>//!
<a href=#163 id=163 data-nosnippet>163</a>//! 1. The zeroing operation can't be "optimized away" by the compiler.
<a href=#164 id=164 data-nosnippet>164</a>//! 2. All subsequent reads to memory will see "zeroized" values.
<a href=#165 id=165 data-nosnippet>165</a>//!
<a href=#166 id=166 data-nosnippet>166</a>//! LLVM's volatile semantics ensure #1 is true.
<a href=#167 id=167 data-nosnippet>167</a>//!
<a href=#168 id=168 data-nosnippet>168</a>//! Additionally, thanks to work by the [Unsafe Code Guidelines Working Group],
<a href=#169 id=169 data-nosnippet>169</a>//! we can now fairly confidently say #2 is true as well. Previously there were
<a href=#170 id=170 data-nosnippet>170</a>//! worries that the approach used by this crate (mixing volatile and
<a href=#171 id=171 data-nosnippet>171</a>//! non-volatile accesses) was undefined behavior due to language contained
<a href=#172 id=172 data-nosnippet>172</a>//! in the documentation for `write_volatile`, however after some discussion
<a href=#173 id=173 data-nosnippet>173</a>//! [these remarks have been removed] and the specific usage pattern in this
<a href=#174 id=174 data-nosnippet>174</a>//! crate is considered to be well-defined.
<a href=#175 id=175 data-nosnippet>175</a>//!
<a href=#176 id=176 data-nosnippet>176</a>//! Additionally this crate leverages [`core::sync::atomic::compiler_fence`]
<a href=#177 id=177 data-nosnippet>177</a>//! with the strictest ordering
<a href=#178 id=178 data-nosnippet>178</a>//! ([`Ordering::SeqCst`]) as a
<a href=#179 id=179 data-nosnippet>179</a>//! precaution to help ensure reads are not reordered before memory has been
<a href=#180 id=180 data-nosnippet>180</a>//! zeroed.
<a href=#181 id=181 data-nosnippet>181</a>//!
<a href=#182 id=182 data-nosnippet>182</a>//! All of that said, there is still potential for microarchitectural attacks
<a href=#183 id=183 data-nosnippet>183</a>//! (ala Spectre/Meltdown) to leak "zeroized" secrets through covert channels.
<a href=#184 id=184 data-nosnippet>184</a>//! This crate makes no guarantees that zeroized values cannot be leaked
<a href=#185 id=185 data-nosnippet>185</a>//! through such channels, as they represent flaws in the underlying hardware.
<a href=#186 id=186 data-nosnippet>186</a>//!
<a href=#187 id=187 data-nosnippet>187</a>//! ## Stack/Heap Zeroing Notes
<a href=#188 id=188 data-nosnippet>188</a>//!
<a href=#189 id=189 data-nosnippet>189</a>//! This crate can be used to zero values from either the stack or the heap.
<a href=#190 id=190 data-nosnippet>190</a>//!
<a href=#191 id=191 data-nosnippet>191</a>//! However, be aware several operations in Rust can unintentionally leave
<a href=#192 id=192 data-nosnippet>192</a>//! copies of data in memory. This includes but is not limited to:
<a href=#193 id=193 data-nosnippet>193</a>//!
<a href=#194 id=194 data-nosnippet>194</a>//! - Moves and [`Copy`]
<a href=#195 id=195 data-nosnippet>195</a>//! - Heap reallocation when using [`Vec`] and [`String`]
<a href=#196 id=196 data-nosnippet>196</a>//! - Borrowers of a reference making copies of the data
<a href=#197 id=197 data-nosnippet>197</a>//!
<a href=#198 id=198 data-nosnippet>198</a>//! [`Pin`][`core::pin::Pin`] can be leveraged in conjunction with this crate
<a href=#199 id=199 data-nosnippet>199</a>//! to ensure data kept on the stack isn't moved.
<a href=#200 id=200 data-nosnippet>200</a>//!
<a href=#201 id=201 data-nosnippet>201</a>//! The `Zeroize` impls for `Vec`, `String` and `CString` zeroize the entire
<a href=#202 id=202 data-nosnippet>202</a>//! capacity of their backing buffer, but cannot guarantee copies of the data
<a href=#203 id=203 data-nosnippet>203</a>//! were not previously made by buffer reallocation. It's therefore important
<a href=#204 id=204 data-nosnippet>204</a>//! when attempting to zeroize such buffers to initialize them to the correct
<a href=#205 id=205 data-nosnippet>205</a>//! capacity, and take care to prevent subsequent reallocation.
<a href=#206 id=206 data-nosnippet>206</a>//!
<a href=#207 id=207 data-nosnippet>207</a>//! The `secrecy` crate provides higher-level abstractions for eliminating
<a href=#208 id=208 data-nosnippet>208</a>//! usage patterns which can cause reallocations:
<a href=#209 id=209 data-nosnippet>209</a>//!
<a href=#210 id=210 data-nosnippet>210</a>//! &lt;https://crates.io/crates/secrecy&gt;
<a href=#211 id=211 data-nosnippet>211</a>//!
<a href=#212 id=212 data-nosnippet>212</a>//! ## What about: clearing registers, mlock, mprotect, etc?
<a href=#213 id=213 data-nosnippet>213</a>//!
<a href=#214 id=214 data-nosnippet>214</a>//! This crate is focused on providing simple, unobtrusive support for reliably
<a href=#215 id=215 data-nosnippet>215</a>//! zeroing memory using the best approach possible on stable Rust.
<a href=#216 id=216 data-nosnippet>216</a>//!
<a href=#217 id=217 data-nosnippet>217</a>//! Clearing registers is a difficult problem that can't easily be solved by
<a href=#218 id=218 data-nosnippet>218</a>//! something like a crate, and requires either inline ASM or rustc support.
<a href=#219 id=219 data-nosnippet>219</a>//! See &lt;https://github.com/rust-lang/rust/issues/17046&gt; for background on
<a href=#220 id=220 data-nosnippet>220</a>//! this particular problem.
<a href=#221 id=221 data-nosnippet>221</a>//!
<a href=#222 id=222 data-nosnippet>222</a>//! Other memory protection mechanisms are interesting and useful, but often
<a href=#223 id=223 data-nosnippet>223</a>//! overkill (e.g. defending against RAM scraping or attackers with swap access).
<a href=#224 id=224 data-nosnippet>224</a>//! In as much as there may be merit to these approaches, there are also many
<a href=#225 id=225 data-nosnippet>225</a>//! other crates that already implement more sophisticated memory protections.
<a href=#226 id=226 data-nosnippet>226</a>//! Such protections are explicitly out-of-scope for this crate.
<a href=#227 id=227 data-nosnippet>227</a>//!
<a href=#228 id=228 data-nosnippet>228</a>//! Zeroing memory is [good cryptographic hygiene] and this crate seeks to promote
<a href=#229 id=229 data-nosnippet>229</a>//! it in the most unobtrusive manner possible. This includes omitting complex
<a href=#230 id=230 data-nosnippet>230</a>//! `unsafe` memory protection systems and just trying to make the best memory
<a href=#231 id=231 data-nosnippet>231</a>//! zeroing crate available.
<a href=#232 id=232 data-nosnippet>232</a>//!
<a href=#233 id=233 data-nosnippet>233</a>//! [Zeroing memory securely is hard]: http://www.daemonology.net/blog/2014-09-04-how-to-zero-a-buffer.html
<a href=#234 id=234 data-nosnippet>234</a>//! [Unsafe Code Guidelines Working Group]: https://github.com/rust-lang/unsafe-code-guidelines
<a href=#235 id=235 data-nosnippet>235</a>//! [these remarks have been removed]: https://github.com/rust-lang/rust/pull/60972
<a href=#236 id=236 data-nosnippet>236</a>//! [good cryptographic hygiene]: https://github.com/veorq/cryptocoding#clean-memory-of-secret-data
<a href=#237 id=237 data-nosnippet>237</a>//! [`Ordering::SeqCst`]: core::sync::atomic::Ordering::SeqCst
<a href=#238 id=238 data-nosnippet>238</a>
<a href=#239 id=239 data-nosnippet>239</a></span><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#240 id=240 data-nosnippet>240</a></span><span class="kw">extern crate </span>alloc;
<a href=#241 id=241 data-nosnippet>241</a>
<a href=#242 id=242 data-nosnippet>242</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#243 id=243 data-nosnippet>243</a></span><span class="kw">extern crate </span>std;
<a href=#244 id=244 data-nosnippet>244</a>
<a href=#245 id=245 data-nosnippet>245</a><span class="attr">#[cfg(feature = <span class="string">"zeroize_derive"</span>)]
<a href=#246 id=246 data-nosnippet>246</a></span><span class="kw">pub use </span>zeroize_derive::{Zeroize, ZeroizeOnDrop};
<a href=#247 id=247 data-nosnippet>247</a>
<a href=#248 id=248 data-nosnippet>248</a><span class="attr">#[cfg(target_arch = <span class="string">"aarch64"</span>)]
<a href=#249 id=249 data-nosnippet>249</a></span><span class="kw">mod </span>aarch64;
<a href=#250 id=250 data-nosnippet>250</a><span class="attr">#[cfg(any(target_arch = <span class="string">"x86"</span>, target_arch = <span class="string">"x86_64"</span>))]
<a href=#251 id=251 data-nosnippet>251</a></span><span class="kw">mod </span>x86;
<a href=#252 id=252 data-nosnippet>252</a>
<a href=#253 id=253 data-nosnippet>253</a><span class="kw">use </span>core::{
<a href=#254 id=254 data-nosnippet>254</a> marker::{PhantomData, PhantomPinned},
<a href=#255 id=255 data-nosnippet>255</a> mem::{size_of, MaybeUninit},
<a href=#256 id=256 data-nosnippet>256</a> num::{
<a href=#257 id=257 data-nosnippet>257</a> <span class="self">self</span>, NonZeroI128, NonZeroI16, NonZeroI32, NonZeroI64, NonZeroI8, NonZeroIsize,
<a href=#258 id=258 data-nosnippet>258</a> NonZeroU128, NonZeroU16, NonZeroU32, NonZeroU64, NonZeroU8, NonZeroUsize,
<a href=#259 id=259 data-nosnippet>259</a> },
<a href=#260 id=260 data-nosnippet>260</a> ops, ptr,
<a href=#261 id=261 data-nosnippet>261</a> slice::IterMut,
<a href=#262 id=262 data-nosnippet>262</a> sync::atomic,
<a href=#263 id=263 data-nosnippet>263</a>};
<a href=#264 id=264 data-nosnippet>264</a>
<a href=#265 id=265 data-nosnippet>265</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#266 id=266 data-nosnippet>266</a></span><span class="kw">use </span>alloc::{boxed::Box, string::String, vec::Vec};
<a href=#267 id=267 data-nosnippet>267</a>
<a href=#268 id=268 data-nosnippet>268</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#269 id=269 data-nosnippet>269</a></span><span class="kw">use </span>std::ffi::CString;
<a href=#270 id=270 data-nosnippet>270</a>
<a href=#271 id=271 data-nosnippet>271</a><span class="doccomment">/// Trait for securely erasing values from memory.
<a href=#272 id=272 data-nosnippet>272</a></span><span class="kw">pub trait </span>Zeroize {
<a href=#273 id=273 data-nosnippet>273</a> <span class="doccomment">/// Zero out this object from memory using Rust intrinsics which ensure the
<a href=#274 id=274 data-nosnippet>274</a> /// zeroization operation is not "optimized away" by the compiler.
<a href=#275 id=275 data-nosnippet>275</a> </span><span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>);
<a href=#276 id=276 data-nosnippet>276</a>}
<a href=#277 id=277 data-nosnippet>277</a>
<a href=#278 id=278 data-nosnippet>278</a><span class="doccomment">/// Marker trait signifying that this type will [`Zeroize::zeroize`] itself on [`Drop`].
<a href=#279 id=279 data-nosnippet>279</a></span><span class="kw">pub trait </span>ZeroizeOnDrop {}
<a href=#280 id=280 data-nosnippet>280</a>
<a href=#281 id=281 data-nosnippet>281</a><span class="doccomment">/// Marker trait for types whose [`Default`] is the desired zeroization result
<a href=#282 id=282 data-nosnippet>282</a></span><span class="kw">pub trait </span>DefaultIsZeroes: Copy + Default + Sized {}
<a href=#283 id=283 data-nosnippet>283</a>
<a href=#284 id=284 data-nosnippet>284</a><span class="doccomment">/// Fallible trait for representing cases where zeroization may or may not be
<a href=#285 id=285 data-nosnippet>285</a>/// possible.
<a href=#286 id=286 data-nosnippet>286</a>///
<a href=#287 id=287 data-nosnippet>287</a>/// This is primarily useful for scenarios like reference counted data, where
<a href=#288 id=288 data-nosnippet>288</a>/// zeroization is only possible when the last reference is dropped.
<a href=#289 id=289 data-nosnippet>289</a></span><span class="kw">pub trait </span>TryZeroize {
<a href=#290 id=290 data-nosnippet>290</a> <span class="doccomment">/// Try to zero out this object from memory using Rust intrinsics which
<a href=#291 id=291 data-nosnippet>291</a> /// ensure the zeroization operation is not "optimized away" by the
<a href=#292 id=292 data-nosnippet>292</a> /// compiler.
<a href=#293 id=293 data-nosnippet>293</a> </span><span class="attr">#[must_use]
<a href=#294 id=294 data-nosnippet>294</a> </span><span class="kw">fn </span>try_zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool;
<a href=#295 id=295 data-nosnippet>295</a>}
<a href=#296 id=296 data-nosnippet>296</a>
<a href=#297 id=297 data-nosnippet>297</a><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>Z
<a href=#298 id=298 data-nosnippet>298</a><span class="kw">where
<a href=#299 id=299 data-nosnippet>299</a> </span>Z: DefaultIsZeroes,
<a href=#300 id=300 data-nosnippet>300</a>{
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#302 id=302 data-nosnippet>302</a> volatile_write(<span class="self">self</span>, Z::default());
<a href=#303 id=303 data-nosnippet>303</a> atomic_fence();
<a href=#304 id=304 data-nosnippet>304</a> }
<a href=#305 id=305 data-nosnippet>305</a>}
<a href=#306 id=306 data-nosnippet>306</a>
<a href=#307 id=307 data-nosnippet>307</a><span class="macro">macro_rules!</span> impl_zeroize_with_default {
<a href=#308 id=308 data-nosnippet>308</a> ($(<span class="macro-nonterminal">$type</span>:ty),+) =&gt; {
<a href=#309 id=309 data-nosnippet>309</a> $(<span class="kw">impl </span>DefaultIsZeroes <span class="kw">for </span><span class="macro-nonterminal">$type </span>{})+
<a href=#310 id=310 data-nosnippet>310</a> };
<a href=#311 id=311 data-nosnippet>311</a>}
<a href=#312 id=312 data-nosnippet>312</a>
<a href=#313 id=313 data-nosnippet>313</a><span class="attr">#[rustfmt::skip]
<a href=#314 id=314 data-nosnippet>314</a></span><span class="macro">impl_zeroize_with_default!</span> {
<a href=#315 id=315 data-nosnippet>315</a> PhantomPinned, (), bool, char,
<a href=#316 id=316 data-nosnippet>316</a> f32, f64,
<a href=#317 id=317 data-nosnippet>317</a> i8, i16, i32, i64, i128, isize,
<a href=#318 id=318 data-nosnippet>318</a> u8, u16, u32, u64, u128, usize
<a href=#319 id=319 data-nosnippet>319</a>}
<a href=#320 id=320 data-nosnippet>320</a>
<a href=#321 id=321 data-nosnippet>321</a><span class="doccomment">/// `PhantomPinned` is zero sized so provide a ZeroizeOnDrop implementation.
<a href=#322 id=322 data-nosnippet>322</a></span><span class="kw">impl </span>ZeroizeOnDrop <span class="kw">for </span>PhantomPinned {}
<a href=#323 id=323 data-nosnippet>323</a>
<a href=#324 id=324 data-nosnippet>324</a><span class="doccomment">/// `()` is zero sized so provide a ZeroizeOnDrop implementation.
<a href=#325 id=325 data-nosnippet>325</a></span><span class="kw">impl </span>ZeroizeOnDrop <span class="kw">for </span>() {}
<a href=#326 id=326 data-nosnippet>326</a>
<a href=#327 id=327 data-nosnippet>327</a><span class="macro">macro_rules!</span> impl_zeroize_for_non_zero {
<a href=#328 id=328 data-nosnippet>328</a> ($(<span class="macro-nonterminal">$type</span>:ty),+) =&gt; {
<a href=#329 id=329 data-nosnippet>329</a> $(
<a href=#330 id=330 data-nosnippet>330</a> <span class="kw">impl </span>Zeroize <span class="kw">for </span><span class="macro-nonterminal">$type </span>{
<a href=#331 id=331 data-nosnippet>331</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#332 id=332 data-nosnippet>332</a> <span class="kw">const </span>ONE: <span class="macro-nonterminal">$type </span>= <span class="kw">match </span>&lt;<span class="macro-nonterminal">$type</span>&gt;::new(<span class="number">1</span>) {
<a href=#333 id=333 data-nosnippet>333</a> <span class="prelude-val">Some</span>(one) =&gt; one,
<a href=#334 id=334 data-nosnippet>334</a> <span class="prelude-val">None </span>=&gt; <span class="macro">unreachable!</span>(),
<a href=#335 id=335 data-nosnippet>335</a> };
<a href=#336 id=336 data-nosnippet>336</a> volatile_write(<span class="self">self</span>, ONE);
<a href=#337 id=337 data-nosnippet>337</a> atomic_fence();
<a href=#338 id=338 data-nosnippet>338</a> }
<a href=#339 id=339 data-nosnippet>339</a> }
<a href=#340 id=340 data-nosnippet>340</a> )+
<a href=#341 id=341 data-nosnippet>341</a> };
<a href=#342 id=342 data-nosnippet>342</a>}
<a href=#343 id=343 data-nosnippet>343</a>
<a href=#344 id=344 data-nosnippet>344</a><span class="macro">impl_zeroize_for_non_zero!</span>(
<a href=#345 id=345 data-nosnippet>345</a> NonZeroI8,
<a href=#346 id=346 data-nosnippet>346</a> NonZeroI16,
<a href=#347 id=347 data-nosnippet>347</a> NonZeroI32,
<a href=#348 id=348 data-nosnippet>348</a> NonZeroI64,
<a href=#349 id=349 data-nosnippet>349</a> NonZeroI128,
<a href=#350 id=350 data-nosnippet>350</a> NonZeroIsize,
<a href=#351 id=351 data-nosnippet>351</a> NonZeroU8,
<a href=#352 id=352 data-nosnippet>352</a> NonZeroU16,
<a href=#353 id=353 data-nosnippet>353</a> NonZeroU32,
<a href=#354 id=354 data-nosnippet>354</a> NonZeroU64,
<a href=#355 id=355 data-nosnippet>355</a> NonZeroU128,
<a href=#356 id=356 data-nosnippet>356</a> NonZeroUsize
<a href=#357 id=357 data-nosnippet>357</a>);
<a href=#358 id=358 data-nosnippet>358</a>
<a href=#359 id=359 data-nosnippet>359</a><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>num::Wrapping&lt;Z&gt;
<a href=#360 id=360 data-nosnippet>360</a><span class="kw">where
<a href=#361 id=361 data-nosnippet>361</a> </span>Z: Zeroize,
<a href=#362 id=362 data-nosnippet>362</a>{
<a href=#363 id=363 data-nosnippet>363</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#364 id=364 data-nosnippet>364</a> <span class="self">self</span>.<span class="number">0</span>.zeroize();
<a href=#365 id=365 data-nosnippet>365</a> }
<a href=#366 id=366 data-nosnippet>366</a>}
<a href=#367 id=367 data-nosnippet>367</a>
<a href=#368 id=368 data-nosnippet>368</a><span class="doccomment">/// Impl [`Zeroize`] on arrays of types that impl [`Zeroize`].
<a href=#369 id=369 data-nosnippet>369</a></span><span class="kw">impl</span>&lt;Z, <span class="kw">const </span>N: usize&gt; Zeroize <span class="kw">for </span>[Z; N]
<a href=#370 id=370 data-nosnippet>370</a><span class="kw">where
<a href=#371 id=371 data-nosnippet>371</a> </span>Z: Zeroize,
<a href=#372 id=372 data-nosnippet>372</a>{
<a href=#373 id=373 data-nosnippet>373</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#374 id=374 data-nosnippet>374</a> <span class="self">self</span>.iter_mut().zeroize();
<a href=#375 id=375 data-nosnippet>375</a> }
<a href=#376 id=376 data-nosnippet>376</a>}
<a href=#377 id=377 data-nosnippet>377</a>
<a href=#378 id=378 data-nosnippet>378</a><span class="doccomment">/// Impl [`ZeroizeOnDrop`] on arrays of types that impl [`ZeroizeOnDrop`].
<a href=#379 id=379 data-nosnippet>379</a></span><span class="kw">impl</span>&lt;Z, <span class="kw">const </span>N: usize&gt; ZeroizeOnDrop <span class="kw">for </span>[Z; N] <span class="kw">where </span>Z: ZeroizeOnDrop {}
<a href=#380 id=380 data-nosnippet>380</a>
<a href=#381 id=381 data-nosnippet>381</a><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>IterMut&lt;<span class="lifetime">'_</span>, Z&gt;
<a href=#382 id=382 data-nosnippet>382</a><span class="kw">where
<a href=#383 id=383 data-nosnippet>383</a> </span>Z: Zeroize,
<a href=#384 id=384 data-nosnippet>384</a>{
<a href=#385 id=385 data-nosnippet>385</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#386 id=386 data-nosnippet>386</a> <span class="kw">for </span>elem <span class="kw">in </span><span class="self">self </span>{
<a href=#387 id=387 data-nosnippet>387</a> elem.zeroize();
<a href=#388 id=388 data-nosnippet>388</a> }
<a href=#389 id=389 data-nosnippet>389</a> }
<a href=#390 id=390 data-nosnippet>390</a>}
<a href=#391 id=391 data-nosnippet>391</a>
<a href=#392 id=392 data-nosnippet>392</a><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span><span class="prelude-ty">Option</span>&lt;Z&gt;
<a href=#393 id=393 data-nosnippet>393</a><span class="kw">where
<a href=#394 id=394 data-nosnippet>394</a> </span>Z: Zeroize,
<a href=#395 id=395 data-nosnippet>395</a>{
<a href=#396 id=396 data-nosnippet>396</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#397 id=397 data-nosnippet>397</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(value) = <span class="self">self </span>{
<a href=#398 id=398 data-nosnippet>398</a> value.zeroize();
<a href=#399 id=399 data-nosnippet>399</a>
<a href=#400 id=400 data-nosnippet>400</a> <span class="comment">// Ensures self is None and that the value was dropped. Without the take, the drop
<a href=#401 id=401 data-nosnippet>401</a> // of the (zeroized) value isn't called, which might lead to a leak or other
<a href=#402 id=402 data-nosnippet>402</a> // unexpected behavior. For example, if this were Option&lt;Vec&lt;T&gt;&gt;, the above call to
<a href=#403 id=403 data-nosnippet>403</a> // zeroize would not free the allocated memory, but the the `take` call will.
<a href=#404 id=404 data-nosnippet>404</a> </span><span class="self">self</span>.take();
<a href=#405 id=405 data-nosnippet>405</a> }
<a href=#406 id=406 data-nosnippet>406</a>
<a href=#407 id=407 data-nosnippet>407</a> <span class="comment">// Ensure that if the `Option` were previously `Some` but a value was copied/moved out
<a href=#408 id=408 data-nosnippet>408</a> // that the remaining space in the `Option` is zeroized.
<a href=#409 id=409 data-nosnippet>409</a> //
<a href=#410 id=410 data-nosnippet>410</a> // Safety:
<a href=#411 id=411 data-nosnippet>411</a> //
<a href=#412 id=412 data-nosnippet>412</a> // The memory pointed to by `self` is valid for `size_of::&lt;Self&gt;()` bytes.
<a href=#413 id=413 data-nosnippet>413</a> // It is also properly aligned, because `u8` has an alignment of `1`.
<a href=#414 id=414 data-nosnippet>414</a> </span><span class="kw">unsafe </span>{
<a href=#415 id=415 data-nosnippet>415</a> volatile_set((<span class="self">self </span><span class="kw">as </span><span class="kw-2">*mut </span><span class="self">Self</span>).cast::&lt;u8&gt;(), <span class="number">0</span>, size_of::&lt;<span class="self">Self</span>&gt;());
<a href=#416 id=416 data-nosnippet>416</a> }
<a href=#417 id=417 data-nosnippet>417</a>
<a href=#418 id=418 data-nosnippet>418</a> <span class="comment">// Ensures self is overwritten with the `None` bit pattern. volatile_write can't be
<a href=#419 id=419 data-nosnippet>419</a> // used because Option&lt;Z&gt; is not copy.
<a href=#420 id=420 data-nosnippet>420</a> //
<a href=#421 id=421 data-nosnippet>421</a> // Safety:
<a href=#422 id=422 data-nosnippet>422</a> //
<a href=#423 id=423 data-nosnippet>423</a> // self is safe to replace with `None`, which the take() call above should have
<a href=#424 id=424 data-nosnippet>424</a> // already done semantically. Any value which needed to be dropped will have been
<a href=#425 id=425 data-nosnippet>425</a> // done so by take().
<a href=#426 id=426 data-nosnippet>426</a> </span><span class="kw">unsafe </span>{ ptr::write_volatile(<span class="self">self</span>, <span class="prelude-val">None</span>) }
<a href=#427 id=427 data-nosnippet>427</a>
<a href=#428 id=428 data-nosnippet>428</a> atomic_fence();
<a href=#429 id=429 data-nosnippet>429</a> }
<a href=#430 id=430 data-nosnippet>430</a>}
<a href=#431 id=431 data-nosnippet>431</a>
<a href=#432 id=432 data-nosnippet>432</a><span class="kw">impl</span>&lt;Z&gt; ZeroizeOnDrop <span class="kw">for </span><span class="prelude-ty">Option</span>&lt;Z&gt; <span class="kw">where </span>Z: ZeroizeOnDrop {}
<a href=#433 id=433 data-nosnippet>433</a>
<a href=#434 id=434 data-nosnippet>434</a><span class="doccomment">/// Impl [`Zeroize`] on [`MaybeUninit`] types.
<a href=#435 id=435 data-nosnippet>435</a>///
<a href=#436 id=436 data-nosnippet>436</a>/// This fills the memory with zeroes.
<a href=#437 id=437 data-nosnippet>437</a>/// Note that this ignore invariants that `Z` might have, because
<a href=#438 id=438 data-nosnippet>438</a>/// [`MaybeUninit`] removes all invariants.
<a href=#439 id=439 data-nosnippet>439</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>MaybeUninit&lt;Z&gt; {
<a href=#440 id=440 data-nosnippet>440</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#441 id=441 data-nosnippet>441</a> <span class="comment">// Safety:
<a href=#442 id=442 data-nosnippet>442</a> // `MaybeUninit` is valid for any byte pattern, including zeros.
<a href=#443 id=443 data-nosnippet>443</a> </span><span class="kw">unsafe </span>{ ptr::write_volatile(<span class="self">self</span>, MaybeUninit::zeroed()) }
<a href=#444 id=444 data-nosnippet>444</a> atomic_fence();
<a href=#445 id=445 data-nosnippet>445</a> }
<a href=#446 id=446 data-nosnippet>446</a>}
<a href=#447 id=447 data-nosnippet>447</a>
<a href=#448 id=448 data-nosnippet>448</a><span class="doccomment">/// Impl [`Zeroize`] on slices of [`MaybeUninit`] types.
<a href=#449 id=449 data-nosnippet>449</a>///
<a href=#450 id=450 data-nosnippet>450</a>/// This impl can eventually be optimized using an memset intrinsic,
<a href=#451 id=451 data-nosnippet>451</a>/// such as [`core::intrinsics::volatile_set_memory`].
<a href=#452 id=452 data-nosnippet>452</a>///
<a href=#453 id=453 data-nosnippet>453</a>/// This fills the slice with zeroes.
<a href=#454 id=454 data-nosnippet>454</a>///
<a href=#455 id=455 data-nosnippet>455</a>/// Note that this ignore invariants that `Z` might have, because
<a href=#456 id=456 data-nosnippet>456</a>/// [`MaybeUninit`] removes all invariants.
<a href=#457 id=457 data-nosnippet>457</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>[MaybeUninit&lt;Z&gt;] {
<a href=#458 id=458 data-nosnippet>458</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#459 id=459 data-nosnippet>459</a> <span class="kw">let </span>ptr = <span class="self">self</span>.as_mut_ptr().cast::&lt;MaybeUninit&lt;u8&gt;&gt;();
<a href=#460 id=460 data-nosnippet>460</a> <span class="kw">let </span>size = <span class="self">self</span>.len().checked_mul(size_of::&lt;Z&gt;()).unwrap();
<a href=#461 id=461 data-nosnippet>461</a> <span class="macro">assert!</span>(size &lt;= isize::MAX <span class="kw">as </span>usize);
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a> <span class="comment">// Safety:
<a href=#464 id=464 data-nosnippet>464</a> //
<a href=#465 id=465 data-nosnippet>465</a> // This is safe, because every valid pointer is well aligned for u8
<a href=#466 id=466 data-nosnippet>466</a> // and it is backed by a single allocated object for at least `self.len() * size_pf::&lt;Z&gt;()` bytes.
<a href=#467 id=467 data-nosnippet>467</a> // and 0 is a valid value for `MaybeUninit&lt;Z&gt;`
<a href=#468 id=468 data-nosnippet>468</a> // The memory of the slice should not wrap around the address space.
<a href=#469 id=469 data-nosnippet>469</a> </span><span class="kw">unsafe </span>{ volatile_set(ptr, MaybeUninit::zeroed(), size) }
<a href=#470 id=470 data-nosnippet>470</a> atomic_fence();
<a href=#471 id=471 data-nosnippet>471</a> }
<a href=#472 id=472 data-nosnippet>472</a>}
<a href=#473 id=473 data-nosnippet>473</a>
<a href=#474 id=474 data-nosnippet>474</a><span class="doccomment">/// Impl [`Zeroize`] on slices of types that can be zeroized with [`Default`].
<a href=#475 id=475 data-nosnippet>475</a>///
<a href=#476 id=476 data-nosnippet>476</a>/// This impl can eventually be optimized using an memset intrinsic,
<a href=#477 id=477 data-nosnippet>477</a>/// such as [`core::intrinsics::volatile_set_memory`]. For that reason the
<a href=#478 id=478 data-nosnippet>478</a>/// blanket impl on slices is bounded by [`DefaultIsZeroes`].
<a href=#479 id=479 data-nosnippet>479</a>///
<a href=#480 id=480 data-nosnippet>480</a>/// To zeroize a mut slice of `Z: Zeroize` which does not impl
<a href=#481 id=481 data-nosnippet>481</a>/// [`DefaultIsZeroes`], call `iter_mut().zeroize()`.
<a href=#482 id=482 data-nosnippet>482</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>[Z]
<a href=#483 id=483 data-nosnippet>483</a><span class="kw">where
<a href=#484 id=484 data-nosnippet>484</a> </span>Z: DefaultIsZeroes,
<a href=#485 id=485 data-nosnippet>485</a>{
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#487 id=487 data-nosnippet>487</a> <span class="macro">assert!</span>(<span class="self">self</span>.len() &lt;= isize::MAX <span class="kw">as </span>usize);
<a href=#488 id=488 data-nosnippet>488</a>
<a href=#489 id=489 data-nosnippet>489</a> <span class="comment">// Safety:
<a href=#490 id=490 data-nosnippet>490</a> //
<a href=#491 id=491 data-nosnippet>491</a> // This is safe, because the slice is well aligned and is backed by a single allocated
<a href=#492 id=492 data-nosnippet>492</a> // object for at least `self.len()` elements of type `Z`.
<a href=#493 id=493 data-nosnippet>493</a> // `self.len()` is also not larger than an `isize`, because of the assertion above.
<a href=#494 id=494 data-nosnippet>494</a> // The memory of the slice should not wrap around the address space.
<a href=#495 id=495 data-nosnippet>495</a> </span><span class="kw">unsafe </span>{ volatile_set(<span class="self">self</span>.as_mut_ptr(), Z::default(), <span class="self">self</span>.len()) };
<a href=#496 id=496 data-nosnippet>496</a> atomic_fence();
<a href=#497 id=497 data-nosnippet>497</a> }
<a href=#498 id=498 data-nosnippet>498</a>}
<a href=#499 id=499 data-nosnippet>499</a>
<a href=#500 id=500 data-nosnippet>500</a><span class="kw">impl </span>Zeroize <span class="kw">for </span>str {
<a href=#501 id=501 data-nosnippet>501</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#502 id=502 data-nosnippet>502</a> <span class="comment">// Safety:
<a href=#503 id=503 data-nosnippet>503</a> // A zeroized byte slice is a valid UTF-8 string.
<a href=#504 id=504 data-nosnippet>504</a> </span><span class="kw">unsafe </span>{ <span class="self">self</span>.as_bytes_mut().zeroize() }
<a href=#505 id=505 data-nosnippet>505</a> }
<a href=#506 id=506 data-nosnippet>506</a>}
<a href=#507 id=507 data-nosnippet>507</a>
<a href=#508 id=508 data-nosnippet>508</a><span class="doccomment">/// [`PhantomData`] is always zero sized so provide a [`Zeroize`] implementation.
<a href=#509 id=509 data-nosnippet>509</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>PhantomData&lt;Z&gt; {
<a href=#510 id=510 data-nosnippet>510</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {}
<a href=#511 id=511 data-nosnippet>511</a>}
<a href=#512 id=512 data-nosnippet>512</a>
<a href=#513 id=513 data-nosnippet>513</a><span class="doccomment">/// [`PhantomData` is always zero sized so provide a ZeroizeOnDrop implementation.
<a href=#514 id=514 data-nosnippet>514</a></span><span class="kw">impl</span>&lt;Z&gt; ZeroizeOnDrop <span class="kw">for </span>PhantomData&lt;Z&gt; {}
<a href=#515 id=515 data-nosnippet>515</a>
<a href=#516 id=516 data-nosnippet>516</a><span class="macro">macro_rules!</span> impl_zeroize_tuple {
<a href=#517 id=517 data-nosnippet>517</a> ( $( <span class="macro-nonterminal">$type_name</span>:ident ),+ ) =&gt; {
<a href=#518 id=518 data-nosnippet>518</a> <span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$type_name</span>: Zeroize),+&gt; Zeroize <span class="kw">for </span>($(<span class="macro-nonterminal">$type_name</span>,)+) {
<a href=#519 id=519 data-nosnippet>519</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#520 id=520 data-nosnippet>520</a> <span class="attr">#[allow(non_snake_case)]
<a href=#521 id=521 data-nosnippet>521</a> </span><span class="kw">let </span>($(<span class="macro-nonterminal">$type_name</span>,)+) = <span class="self">self</span>;
<a href=#522 id=522 data-nosnippet>522</a> $(<span class="macro-nonterminal">$type_name</span>.zeroize());+
<a href=#523 id=523 data-nosnippet>523</a> }
<a href=#524 id=524 data-nosnippet>524</a> }
<a href=#525 id=525 data-nosnippet>525</a>
<a href=#526 id=526 data-nosnippet>526</a> <span class="kw">impl</span>&lt;$(<span class="macro-nonterminal">$type_name</span>: ZeroizeOnDrop),+&gt; ZeroizeOnDrop <span class="kw">for </span>($(<span class="macro-nonterminal">$type_name</span>,)+) { }
<a href=#527 id=527 data-nosnippet>527</a> }
<a href=#528 id=528 data-nosnippet>528</a>}
<a href=#529 id=529 data-nosnippet>529</a>
<a href=#530 id=530 data-nosnippet>530</a><span class="comment">// Generic implementations for tuples up to 10 parameters.
<a href=#531 id=531 data-nosnippet>531</a></span><span class="macro">impl_zeroize_tuple!</span>(A);
<a href=#532 id=532 data-nosnippet>532</a><span class="macro">impl_zeroize_tuple!</span>(A, B);
<a href=#533 id=533 data-nosnippet>533</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C);
<a href=#534 id=534 data-nosnippet>534</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D);
<a href=#535 id=535 data-nosnippet>535</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E);
<a href=#536 id=536 data-nosnippet>536</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E, F);
<a href=#537 id=537 data-nosnippet>537</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E, F, G);
<a href=#538 id=538 data-nosnippet>538</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E, F, G, H);
<a href=#539 id=539 data-nosnippet>539</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E, F, G, H, I);
<a href=#540 id=540 data-nosnippet>540</a><span class="macro">impl_zeroize_tuple!</span>(A, B, C, D, E, F, G, H, I, J);
<a href=#541 id=541 data-nosnippet>541</a>
<a href=#542 id=542 data-nosnippet>542</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#543 id=543 data-nosnippet>543</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>Vec&lt;Z&gt;
<a href=#544 id=544 data-nosnippet>544</a><span class="kw">where
<a href=#545 id=545 data-nosnippet>545</a> </span>Z: Zeroize,
<a href=#546 id=546 data-nosnippet>546</a>{
<a href=#547 id=547 data-nosnippet>547</a> <span class="doccomment">/// "Best effort" zeroization for `Vec`.
<a href=#548 id=548 data-nosnippet>548</a> ///
<a href=#549 id=549 data-nosnippet>549</a> /// Ensures the entire capacity of the `Vec` is zeroed. Cannot ensure that
<a href=#550 id=550 data-nosnippet>550</a> /// previous reallocations did not leave values on the heap.
<a href=#551 id=551 data-nosnippet>551</a> </span><span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#552 id=552 data-nosnippet>552</a> <span class="comment">// Zeroize all the initialized elements.
<a href=#553 id=553 data-nosnippet>553</a> </span><span class="self">self</span>.iter_mut().zeroize();
<a href=#554 id=554 data-nosnippet>554</a>
<a href=#555 id=555 data-nosnippet>555</a> <span class="comment">// Set the Vec's length to 0 and drop all the elements.
<a href=#556 id=556 data-nosnippet>556</a> </span><span class="self">self</span>.clear();
<a href=#557 id=557 data-nosnippet>557</a>
<a href=#558 id=558 data-nosnippet>558</a> <span class="comment">// Zero the full capacity of `Vec`.
<a href=#559 id=559 data-nosnippet>559</a> </span><span class="self">self</span>.spare_capacity_mut().zeroize();
<a href=#560 id=560 data-nosnippet>560</a> }
<a href=#561 id=561 data-nosnippet>561</a>}
<a href=#562 id=562 data-nosnippet>562</a>
<a href=#563 id=563 data-nosnippet>563</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#564 id=564 data-nosnippet>564</a></span><span class="kw">impl</span>&lt;Z&gt; ZeroizeOnDrop <span class="kw">for </span>Vec&lt;Z&gt; <span class="kw">where </span>Z: ZeroizeOnDrop {}
<a href=#565 id=565 data-nosnippet>565</a>
<a href=#566 id=566 data-nosnippet>566</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#567 id=567 data-nosnippet>567</a></span><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>Box&lt;[Z]&gt;
<a href=#568 id=568 data-nosnippet>568</a><span class="kw">where
<a href=#569 id=569 data-nosnippet>569</a> </span>Z: Zeroize,
<a href=#570 id=570 data-nosnippet>570</a>{
<a href=#571 id=571 data-nosnippet>571</a> <span class="doccomment">/// Unlike `Vec`, `Box&lt;[Z]&gt;` cannot reallocate, so we can be sure that we are not leaving
<a href=#572 id=572 data-nosnippet>572</a> /// values on the heap.
<a href=#573 id=573 data-nosnippet>573</a> </span><span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#574 id=574 data-nosnippet>574</a> <span class="self">self</span>.iter_mut().zeroize();
<a href=#575 id=575 data-nosnippet>575</a> }
<a href=#576 id=576 data-nosnippet>576</a>}
<a href=#577 id=577 data-nosnippet>577</a>
<a href=#578 id=578 data-nosnippet>578</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#579 id=579 data-nosnippet>579</a></span><span class="kw">impl</span>&lt;Z&gt; ZeroizeOnDrop <span class="kw">for </span>Box&lt;[Z]&gt; <span class="kw">where </span>Z: ZeroizeOnDrop {}
<a href=#580 id=580 data-nosnippet>580</a>
<a href=#581 id=581 data-nosnippet>581</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#582 id=582 data-nosnippet>582</a></span><span class="kw">impl </span>Zeroize <span class="kw">for </span>Box&lt;str&gt; {
<a href=#583 id=583 data-nosnippet>583</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#584 id=584 data-nosnippet>584</a> <span class="self">self</span>.as_mut().zeroize();
<a href=#585 id=585 data-nosnippet>585</a> }
<a href=#586 id=586 data-nosnippet>586</a>}
<a href=#587 id=587 data-nosnippet>587</a>
<a href=#588 id=588 data-nosnippet>588</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
<a href=#589 id=589 data-nosnippet>589</a></span><span class="kw">impl </span>Zeroize <span class="kw">for </span>String {
<a href=#590 id=590 data-nosnippet>590</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#591 id=591 data-nosnippet>591</a> <span class="kw">unsafe </span>{ <span class="self">self</span>.as_mut_vec() }.zeroize();
<a href=#592 id=592 data-nosnippet>592</a> }
<a href=#593 id=593 data-nosnippet>593</a>}
<a href=#594 id=594 data-nosnippet>594</a>
<a href=#595 id=595 data-nosnippet>595</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
<a href=#596 id=596 data-nosnippet>596</a></span><span class="kw">impl </span>Zeroize <span class="kw">for </span>CString {
<a href=#597 id=597 data-nosnippet>597</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#598 id=598 data-nosnippet>598</a> <span class="kw">use </span>core::mem;
<a href=#599 id=599 data-nosnippet>599</a>
<a href=#600 id=600 data-nosnippet>600</a> <span class="comment">// mem::take uses replace internally to swap the pointer
<a href=#601 id=601 data-nosnippet>601</a> // Unfortunately this results in an allocation for a Box::new(&amp;[0]) as CString must
<a href=#602 id=602 data-nosnippet>602</a> // contain a trailing zero byte
<a href=#603 id=603 data-nosnippet>603</a> </span><span class="kw">let </span>this = mem::take(<span class="self">self</span>);
<a href=#604 id=604 data-nosnippet>604</a>
<a href=#605 id=605 data-nosnippet>605</a> <span class="comment">// - CString::into_bytes_with_nul calls ::into_vec which takes ownership of the heap pointer
<a href=#606 id=606 data-nosnippet>606</a> // as a Vec&lt;u8&gt;
<a href=#607 id=607 data-nosnippet>607</a> // - Calling .zeroize() on the resulting vector clears out the bytes
<a href=#608 id=608 data-nosnippet>608</a> // From: https://github.com/RustCrypto/utils/pull/759#issuecomment-1087976570
<a href=#609 id=609 data-nosnippet>609</a> </span><span class="kw">let </span><span class="kw-2">mut </span>buf = this.into_bytes_with_nul();
<a href=#610 id=610 data-nosnippet>610</a> buf.zeroize();
<a href=#611 id=611 data-nosnippet>611</a>
<a href=#612 id=612 data-nosnippet>612</a> <span class="comment">// expect() should never fail, because zeroize() truncates the Vec
<a href=#613 id=613 data-nosnippet>613</a> </span><span class="kw">let </span>zeroed = CString::new(buf).expect(<span class="string">"buf not truncated"</span>);
<a href=#614 id=614 data-nosnippet>614</a>
<a href=#615 id=615 data-nosnippet>615</a> <span class="comment">// Replace self by the zeroed CString to maintain the original ptr of the buffer
<a href=#616 id=616 data-nosnippet>616</a> </span><span class="kw">let _ </span>= mem::replace(<span class="self">self</span>, zeroed);
<a href=#617 id=617 data-nosnippet>617</a> }
<a href=#618 id=618 data-nosnippet>618</a>}
<a href=#619 id=619 data-nosnippet>619</a>
<a href=#620 id=620 data-nosnippet>620</a><span class="doccomment">/// `Zeroizing` is a a wrapper for any `Z: Zeroize` type which implements a
<a href=#621 id=621 data-nosnippet>621</a>/// `Drop` handler which zeroizes dropped values.
<a href=#622 id=622 data-nosnippet>622</a></span><span class="attr">#[derive(Debug, Default, Eq, PartialEq)]
<a href=#623 id=623 data-nosnippet>623</a></span><span class="kw">pub struct </span>Zeroizing&lt;Z: Zeroize&gt;(Z);
<a href=#624 id=624 data-nosnippet>624</a>
<a href=#625 id=625 data-nosnippet>625</a><span class="kw">impl</span>&lt;Z&gt; Zeroizing&lt;Z&gt;
<a href=#626 id=626 data-nosnippet>626</a><span class="kw">where
<a href=#627 id=627 data-nosnippet>627</a> </span>Z: Zeroize,
<a href=#628 id=628 data-nosnippet>628</a>{
<a href=#629 id=629 data-nosnippet>629</a> <span class="doccomment">/// Move value inside a `Zeroizing` wrapper which ensures it will be
<a href=#630 id=630 data-nosnippet>630</a> /// zeroized when it's dropped.
<a href=#631 id=631 data-nosnippet>631</a> </span><span class="attr">#[inline(always)]
<a href=#632 id=632 data-nosnippet>632</a> </span><span class="kw">pub fn </span>new(value: Z) -&gt; <span class="self">Self </span>{
<a href=#633 id=633 data-nosnippet>633</a> <span class="self">Self</span>(value)
<a href=#634 id=634 data-nosnippet>634</a> }
<a href=#635 id=635 data-nosnippet>635</a>}
<a href=#636 id=636 data-nosnippet>636</a>
<a href=#637 id=637 data-nosnippet>637</a><span class="kw">impl</span>&lt;Z: Zeroize + Clone&gt; Clone <span class="kw">for </span>Zeroizing&lt;Z&gt; {
<a href=#638 id=638 data-nosnippet>638</a> <span class="attr">#[inline(always)]
<a href=#639 id=639 data-nosnippet>639</a> </span><span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<a href=#640 id=640 data-nosnippet>640</a> <span class="self">Self</span>(<span class="self">self</span>.<span class="number">0</span>.clone())
<a href=#641 id=641 data-nosnippet>641</a> }
<a href=#642 id=642 data-nosnippet>642</a>
<a href=#643 id=643 data-nosnippet>643</a> <span class="attr">#[inline(always)]
<a href=#644 id=644 data-nosnippet>644</a> </span><span class="kw">fn </span>clone_from(<span class="kw-2">&amp;mut </span><span class="self">self</span>, source: <span class="kw-2">&amp;</span><span class="self">Self</span>) {
<a href=#645 id=645 data-nosnippet>645</a> <span class="self">self</span>.<span class="number">0</span>.zeroize();
<a href=#646 id=646 data-nosnippet>646</a> <span class="self">self</span>.<span class="number">0</span>.clone_from(<span class="kw-2">&amp;</span>source.<span class="number">0</span>);
<a href=#647 id=647 data-nosnippet>647</a> }
<a href=#648 id=648 data-nosnippet>648</a>}
<a href=#649 id=649 data-nosnippet>649</a>
<a href=#650 id=650 data-nosnippet>650</a><span class="kw">impl</span>&lt;Z&gt; From&lt;Z&gt; <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#651 id=651 data-nosnippet>651</a><span class="kw">where
<a href=#652 id=652 data-nosnippet>652</a> </span>Z: Zeroize,
<a href=#653 id=653 data-nosnippet>653</a>{
<a href=#654 id=654 data-nosnippet>654</a> <span class="attr">#[inline(always)]
<a href=#655 id=655 data-nosnippet>655</a> </span><span class="kw">fn </span>from(value: Z) -&gt; Zeroizing&lt;Z&gt; {
<a href=#656 id=656 data-nosnippet>656</a> Zeroizing(value)
<a href=#657 id=657 data-nosnippet>657</a> }
<a href=#658 id=658 data-nosnippet>658</a>}
<a href=#659 id=659 data-nosnippet>659</a>
<a href=#660 id=660 data-nosnippet>660</a><span class="kw">impl</span>&lt;Z&gt; ops::Deref <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#661 id=661 data-nosnippet>661</a><span class="kw">where
<a href=#662 id=662 data-nosnippet>662</a> </span>Z: Zeroize,
<a href=#663 id=663 data-nosnippet>663</a>{
<a href=#664 id=664 data-nosnippet>664</a> <span class="kw">type </span>Target = Z;
<a href=#665 id=665 data-nosnippet>665</a>
<a href=#666 id=666 data-nosnippet>666</a> <span class="attr">#[inline(always)]
<a href=#667 id=667 data-nosnippet>667</a> </span><span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Z {
<a href=#668 id=668 data-nosnippet>668</a> <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0
<a href=#669 id=669 data-nosnippet>669</a> </span>}
<a href=#670 id=670 data-nosnippet>670</a>}
<a href=#671 id=671 data-nosnippet>671</a>
<a href=#672 id=672 data-nosnippet>672</a><span class="kw">impl</span>&lt;Z&gt; ops::DerefMut <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#673 id=673 data-nosnippet>673</a><span class="kw">where
<a href=#674 id=674 data-nosnippet>674</a> </span>Z: Zeroize,
<a href=#675 id=675 data-nosnippet>675</a>{
<a href=#676 id=676 data-nosnippet>676</a> <span class="attr">#[inline(always)]
<a href=#677 id=677 data-nosnippet>677</a> </span><span class="kw">fn </span>deref_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>Z {
<a href=#678 id=678 data-nosnippet>678</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>.<span class="number">0
<a href=#679 id=679 data-nosnippet>679</a> </span>}
<a href=#680 id=680 data-nosnippet>680</a>}
<a href=#681 id=681 data-nosnippet>681</a>
<a href=#682 id=682 data-nosnippet>682</a><span class="kw">impl</span>&lt;T, Z&gt; AsRef&lt;T&gt; <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#683 id=683 data-nosnippet>683</a><span class="kw">where
<a href=#684 id=684 data-nosnippet>684</a> </span>T: <span class="question-mark">?</span>Sized,
<a href=#685 id=685 data-nosnippet>685</a> Z: AsRef&lt;T&gt; + Zeroize,
<a href=#686 id=686 data-nosnippet>686</a>{
<a href=#687 id=687 data-nosnippet>687</a> <span class="attr">#[inline(always)]
<a href=#688 id=688 data-nosnippet>688</a> </span><span class="kw">fn </span>as_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
<a href=#689 id=689 data-nosnippet>689</a> <span class="self">self</span>.<span class="number">0</span>.as_ref()
<a href=#690 id=690 data-nosnippet>690</a> }
<a href=#691 id=691 data-nosnippet>691</a>}
<a href=#692 id=692 data-nosnippet>692</a>
<a href=#693 id=693 data-nosnippet>693</a><span class="kw">impl</span>&lt;T, Z&gt; AsMut&lt;T&gt; <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#694 id=694 data-nosnippet>694</a><span class="kw">where
<a href=#695 id=695 data-nosnippet>695</a> </span>T: <span class="question-mark">?</span>Sized,
<a href=#696 id=696 data-nosnippet>696</a> Z: AsMut&lt;T&gt; + Zeroize,
<a href=#697 id=697 data-nosnippet>697</a>{
<a href=#698 id=698 data-nosnippet>698</a> <span class="attr">#[inline(always)]
<a href=#699 id=699 data-nosnippet>699</a> </span><span class="kw">fn </span>as_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>T {
<a href=#700 id=700 data-nosnippet>700</a> <span class="self">self</span>.<span class="number">0</span>.as_mut()
<a href=#701 id=701 data-nosnippet>701</a> }
<a href=#702 id=702 data-nosnippet>702</a>}
<a href=#703 id=703 data-nosnippet>703</a>
<a href=#704 id=704 data-nosnippet>704</a><span class="kw">impl</span>&lt;Z&gt; Zeroize <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#705 id=705 data-nosnippet>705</a><span class="kw">where
<a href=#706 id=706 data-nosnippet>706</a> </span>Z: Zeroize,
<a href=#707 id=707 data-nosnippet>707</a>{
<a href=#708 id=708 data-nosnippet>708</a> <span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#709 id=709 data-nosnippet>709</a> <span class="self">self</span>.<span class="number">0</span>.zeroize();
<a href=#710 id=710 data-nosnippet>710</a> }
<a href=#711 id=711 data-nosnippet>711</a>}
<a href=#712 id=712 data-nosnippet>712</a>
<a href=#713 id=713 data-nosnippet>713</a><span class="kw">impl</span>&lt;Z&gt; ZeroizeOnDrop <span class="kw">for </span>Zeroizing&lt;Z&gt; <span class="kw">where </span>Z: Zeroize {}
<a href=#714 id=714 data-nosnippet>714</a>
<a href=#715 id=715 data-nosnippet>715</a><span class="kw">impl</span>&lt;Z&gt; Drop <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#716 id=716 data-nosnippet>716</a><span class="kw">where
<a href=#717 id=717 data-nosnippet>717</a> </span>Z: Zeroize,
<a href=#718 id=718 data-nosnippet>718</a>{
<a href=#719 id=719 data-nosnippet>719</a> <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#720 id=720 data-nosnippet>720</a> <span class="self">self</span>.<span class="number">0</span>.zeroize()
<a href=#721 id=721 data-nosnippet>721</a> }
<a href=#722 id=722 data-nosnippet>722</a>}
<a href=#723 id=723 data-nosnippet>723</a>
<a href=#724 id=724 data-nosnippet>724</a><span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
<a href=#725 id=725 data-nosnippet>725</a></span><span class="kw">impl</span>&lt;Z&gt; serde::Serialize <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#726 id=726 data-nosnippet>726</a><span class="kw">where
<a href=#727 id=727 data-nosnippet>727</a> </span>Z: Zeroize + serde::Serialize,
<a href=#728 id=728 data-nosnippet>728</a>{
<a href=#729 id=729 data-nosnippet>729</a> <span class="attr">#[inline(always)]
<a href=#730 id=730 data-nosnippet>730</a> </span><span class="kw">fn </span>serialize&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt;
<a href=#731 id=731 data-nosnippet>731</a> <span class="kw">where
<a href=#732 id=732 data-nosnippet>732</a> </span>S: serde::Serializer,
<a href=#733 id=733 data-nosnippet>733</a> {
<a href=#734 id=734 data-nosnippet>734</a> <span class="self">self</span>.<span class="number">0</span>.serialize(serializer)
<a href=#735 id=735 data-nosnippet>735</a> }
<a href=#736 id=736 data-nosnippet>736</a>}
<a href=#737 id=737 data-nosnippet>737</a>
<a href=#738 id=738 data-nosnippet>738</a><span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
<a href=#739 id=739 data-nosnippet>739</a></span><span class="kw">impl</span>&lt;<span class="lifetime">'de</span>, Z&gt; serde::Deserialize&lt;<span class="lifetime">'de</span>&gt; <span class="kw">for </span>Zeroizing&lt;Z&gt;
<a href=#740 id=740 data-nosnippet>740</a><span class="kw">where
<a href=#741 id=741 data-nosnippet>741</a> </span>Z: Zeroize + serde::Deserialize&lt;<span class="lifetime">'de</span>&gt;,
<a href=#742 id=742 data-nosnippet>742</a>{
<a href=#743 id=743 data-nosnippet>743</a> <span class="attr">#[inline(always)]
<a href=#744 id=744 data-nosnippet>744</a> </span><span class="kw">fn </span>deserialize&lt;D&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt;
<a href=#745 id=745 data-nosnippet>745</a> <span class="kw">where
<a href=#746 id=746 data-nosnippet>746</a> </span>D: serde::Deserializer&lt;<span class="lifetime">'de</span>&gt;,
<a href=#747 id=747 data-nosnippet>747</a> {
<a href=#748 id=748 data-nosnippet>748</a> <span class="prelude-val">Ok</span>(<span class="self">Self</span>(Z::deserialize(deserializer)<span class="question-mark">?</span>))
<a href=#749 id=749 data-nosnippet>749</a> }
<a href=#750 id=750 data-nosnippet>750</a>}
<a href=#751 id=751 data-nosnippet>751</a>
<a href=#752 id=752 data-nosnippet>752</a><span class="doccomment">/// Use fences to prevent accesses from being reordered before this
<a href=#753 id=753 data-nosnippet>753</a>/// point, which should hopefully help ensure that all accessors
<a href=#754 id=754 data-nosnippet>754</a>/// see zeroes after this point.
<a href=#755 id=755 data-nosnippet>755</a></span><span class="attr">#[inline(always)]
<a href=#756 id=756 data-nosnippet>756</a></span><span class="kw">fn </span>atomic_fence() {
<a href=#757 id=757 data-nosnippet>757</a> atomic::compiler_fence(atomic::Ordering::SeqCst);
<a href=#758 id=758 data-nosnippet>758</a>}
<a href=#759 id=759 data-nosnippet>759</a>
<a href=#760 id=760 data-nosnippet>760</a><span class="doccomment">/// Perform a volatile write to the destination
<a href=#761 id=761 data-nosnippet>761</a></span><span class="attr">#[inline(always)]
<a href=#762 id=762 data-nosnippet>762</a></span><span class="kw">fn </span>volatile_write&lt;T: Copy + Sized&gt;(dst: <span class="kw-2">&amp;mut </span>T, src: T) {
<a href=#763 id=763 data-nosnippet>763</a> <span class="kw">unsafe </span>{ ptr::write_volatile(dst, src) }
<a href=#764 id=764 data-nosnippet>764</a>}
<a href=#765 id=765 data-nosnippet>765</a>
<a href=#766 id=766 data-nosnippet>766</a><span class="doccomment">/// Perform a volatile `memset` operation which fills a slice with a value
<a href=#767 id=767 data-nosnippet>767</a>///
<a href=#768 id=768 data-nosnippet>768</a>/// Safety:
<a href=#769 id=769 data-nosnippet>769</a>/// The memory pointed to by `dst` must be a single allocated object that is valid for `count`
<a href=#770 id=770 data-nosnippet>770</a>/// contiguous elements of `T`.
<a href=#771 id=771 data-nosnippet>771</a>/// `count` must not be larger than an `isize`.
<a href=#772 id=772 data-nosnippet>772</a>/// `dst` being offset by `size_of::&lt;T&gt; * count` bytes must not wrap around the address space.
<a href=#773 id=773 data-nosnippet>773</a>/// Also `dst` must be properly aligned.
<a href=#774 id=774 data-nosnippet>774</a></span><span class="attr">#[inline(always)]
<a href=#775 id=775 data-nosnippet>775</a></span><span class="kw">unsafe fn </span>volatile_set&lt;T: Copy + Sized&gt;(dst: <span class="kw-2">*mut </span>T, src: T, count: usize) {
<a href=#776 id=776 data-nosnippet>776</a> <span class="comment">// TODO(tarcieri): use `volatile_set_memory` when stabilized
<a href=#777 id=777 data-nosnippet>777</a> </span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..count {
<a href=#778 id=778 data-nosnippet>778</a> <span class="comment">// Safety:
<a href=#779 id=779 data-nosnippet>779</a> //
<a href=#780 id=780 data-nosnippet>780</a> // This is safe because there is room for at least `count` objects of type `T` in the
<a href=#781 id=781 data-nosnippet>781</a> // allocation pointed to by `dst`, because `count &lt;= isize::MAX` and because
<a href=#782 id=782 data-nosnippet>782</a> // `dst.add(count)` must not wrap around the address space.
<a href=#783 id=783 data-nosnippet>783</a> </span><span class="kw">let </span>ptr = dst.add(i);
<a href=#784 id=784 data-nosnippet>784</a>
<a href=#785 id=785 data-nosnippet>785</a> <span class="comment">// Safety:
<a href=#786 id=786 data-nosnippet>786</a> //
<a href=#787 id=787 data-nosnippet>787</a> // This is safe, because the pointer is valid and because `dst` is well aligned for `T` and
<a href=#788 id=788 data-nosnippet>788</a> // `ptr` is an offset of `dst` by a multiple of `size_of::&lt;T&gt;()` bytes.
<a href=#789 id=789 data-nosnippet>789</a> </span>ptr::write_volatile(ptr, src);
<a href=#790 id=790 data-nosnippet>790</a> }
<a href=#791 id=791 data-nosnippet>791</a>}
<a href=#792 id=792 data-nosnippet>792</a>
<a href=#793 id=793 data-nosnippet>793</a><span class="doccomment">/// Zeroizes a flat type/struct. Only zeroizes the values that it owns, and it does not work on
<a href=#794 id=794 data-nosnippet>794</a>/// dynamically sized values or trait objects. It would be inefficient to use this function on a
<a href=#795 id=795 data-nosnippet>795</a>/// type that already implements `ZeroizeOnDrop`.
<a href=#796 id=796 data-nosnippet>796</a>///
<a href=#797 id=797 data-nosnippet>797</a>/// # Safety
<a href=#798 id=798 data-nosnippet>798</a>/// - The type must not contain references to outside data or dynamically sized data, such as
<a href=#799 id=799 data-nosnippet>799</a>/// `Vec&lt;T&gt;` or `String`.
<a href=#800 id=800 data-nosnippet>800</a>/// - Values stored in the type must not have `Drop` impls.
<a href=#801 id=801 data-nosnippet>801</a>/// - This function can invalidate the type if it is used after this function is called on it.
<a href=#802 id=802 data-nosnippet>802</a>/// It is advisable to call this function only in `impl Drop`.
<a href=#803 id=803 data-nosnippet>803</a>/// - The bit pattern of all zeroes must be valid for the data being zeroized. This may not be
<a href=#804 id=804 data-nosnippet>804</a>/// true for enums and pointers.
<a href=#805 id=805 data-nosnippet>805</a>///
<a href=#806 id=806 data-nosnippet>806</a>/// # Incompatible data types
<a href=#807 id=807 data-nosnippet>807</a>/// Some data types that cannot be safely zeroized using `zeroize_flat_type` include,
<a href=#808 id=808 data-nosnippet>808</a>/// but are not limited to:
<a href=#809 id=809 data-nosnippet>809</a>/// - References: `&amp;T` and `&amp;mut T`
<a href=#810 id=810 data-nosnippet>810</a>/// - Non-nullable types: `NonNull&lt;T&gt;`, `NonZeroU32`, etc.
<a href=#811 id=811 data-nosnippet>811</a>/// - Enums with explicit non-zero tags.
<a href=#812 id=812 data-nosnippet>812</a>/// - Smart pointers and collections: `Arc&lt;T&gt;`, `Box&lt;T&gt;`, `Vec&lt;T&gt;`, `HashMap&lt;K, V&gt;`, `String`, etc.
<a href=#813 id=813 data-nosnippet>813</a>///
<a href=#814 id=814 data-nosnippet>814</a>/// # Examples
<a href=#815 id=815 data-nosnippet>815</a>/// Safe usage for a struct containing strictly flat data:
<a href=#816 id=816 data-nosnippet>816</a>/// ```
<a href=#817 id=817 data-nosnippet>817</a>/// use zeroize::{ZeroizeOnDrop, zeroize_flat_type};
<a href=#818 id=818 data-nosnippet>818</a>///
<a href=#819 id=819 data-nosnippet>819</a>/// struct DataToZeroize {
<a href=#820 id=820 data-nosnippet>820</a>/// flat_data_1: [u8; 32],
<a href=#821 id=821 data-nosnippet>821</a>/// flat_data_2: SomeMoreFlatData,
<a href=#822 id=822 data-nosnippet>822</a>/// }
<a href=#823 id=823 data-nosnippet>823</a>///
<a href=#824 id=824 data-nosnippet>824</a>/// struct SomeMoreFlatData(u64);
<a href=#825 id=825 data-nosnippet>825</a>///
<a href=#826 id=826 data-nosnippet>826</a>/// impl Drop for DataToZeroize {
<a href=#827 id=827 data-nosnippet>827</a>/// fn drop(&amp;mut self) {
<a href=#828 id=828 data-nosnippet>828</a>/// unsafe { zeroize_flat_type(self as *mut Self) }
<a href=#829 id=829 data-nosnippet>829</a>/// }
<a href=#830 id=830 data-nosnippet>830</a>/// }
<a href=#831 id=831 data-nosnippet>831</a>/// impl ZeroizeOnDrop for DataToZeroize {}
<a href=#832 id=832 data-nosnippet>832</a>///
<a href=#833 id=833 data-nosnippet>833</a>/// let mut data = DataToZeroize {
<a href=#834 id=834 data-nosnippet>834</a>/// flat_data_1: [3u8; 32],
<a href=#835 id=835 data-nosnippet>835</a>/// flat_data_2: SomeMoreFlatData(123u64)
<a href=#836 id=836 data-nosnippet>836</a>/// };
<a href=#837 id=837 data-nosnippet>837</a>///
<a href=#838 id=838 data-nosnippet>838</a>/// // data gets zeroized when dropped
<a href=#839 id=839 data-nosnippet>839</a>/// ```
<a href=#840 id=840 data-nosnippet>840</a></span><span class="attr">#[inline(always)]
<a href=#841 id=841 data-nosnippet>841</a></span><span class="kw">pub unsafe fn </span>zeroize_flat_type&lt;F: Sized&gt;(data: <span class="kw-2">*mut </span>F) {
<a href=#842 id=842 data-nosnippet>842</a> <span class="kw">let </span>size = size_of::&lt;F&gt;();
<a href=#843 id=843 data-nosnippet>843</a> <span class="comment">// Safety:
<a href=#844 id=844 data-nosnippet>844</a> //
<a href=#845 id=845 data-nosnippet>845</a> // This is safe because `size_of&lt;T&gt;()` returns the exact size of the object in memory, and
<a href=#846 id=846 data-nosnippet>846</a> // `data_ptr` points directly to the first byte of the data.
<a href=#847 id=847 data-nosnippet>847</a> </span>volatile_set(data <span class="kw">as </span><span class="kw-2">*mut </span>u8, <span class="number">0</span>, size);
<a href=#848 id=848 data-nosnippet>848</a> atomic_fence()
<a href=#849 id=849 data-nosnippet>849</a>}
<a href=#850 id=850 data-nosnippet>850</a>
<a href=#851 id=851 data-nosnippet>851</a><span class="doccomment">/// Internal module used as support for `AssertZeroizeOnDrop`.
<a href=#852 id=852 data-nosnippet>852</a></span><span class="attr">#[doc(hidden)]
<a href=#853 id=853 data-nosnippet>853</a></span><span class="kw">pub mod </span>__internal {
<a href=#854 id=854 data-nosnippet>854</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
<a href=#855 id=855 data-nosnippet>855</a>
<a href=#856 id=856 data-nosnippet>856</a> <span class="doccomment">/// Auto-deref workaround for deriving `ZeroizeOnDrop`.
<a href=#857 id=857 data-nosnippet>857</a> </span><span class="kw">pub trait </span>AssertZeroizeOnDrop {
<a href=#858 id=858 data-nosnippet>858</a> <span class="kw">fn </span>zeroize_or_on_drop(<span class="self">self</span>);
<a href=#859 id=859 data-nosnippet>859</a> }
<a href=#860 id=860 data-nosnippet>860</a>
<a href=#861 id=861 data-nosnippet>861</a> <span class="kw">impl</span>&lt;T: ZeroizeOnDrop + <span class="question-mark">?</span>Sized&gt; AssertZeroizeOnDrop <span class="kw">for </span>&amp;&amp;<span class="kw-2">mut </span>T {
<a href=#862 id=862 data-nosnippet>862</a> <span class="kw">fn </span>zeroize_or_on_drop(<span class="self">self</span>) {}
<a href=#863 id=863 data-nosnippet>863</a> }
<a href=#864 id=864 data-nosnippet>864</a>
<a href=#865 id=865 data-nosnippet>865</a> <span class="doccomment">/// Auto-deref workaround for deriving `ZeroizeOnDrop`.
<a href=#866 id=866 data-nosnippet>866</a> </span><span class="kw">pub trait </span>AssertZeroize {
<a href=#867 id=867 data-nosnippet>867</a> <span class="kw">fn </span>zeroize_or_on_drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>);
<a href=#868 id=868 data-nosnippet>868</a> }
<a href=#869 id=869 data-nosnippet>869</a>
<a href=#870 id=870 data-nosnippet>870</a> <span class="kw">impl</span>&lt;T: Zeroize + <span class="question-mark">?</span>Sized&gt; AssertZeroize <span class="kw">for </span>T {
<a href=#871 id=871 data-nosnippet>871</a> <span class="kw">fn </span>zeroize_or_on_drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#872 id=872 data-nosnippet>872</a> <span class="self">self</span>.zeroize()
<a href=#873 id=873 data-nosnippet>873</a> }
<a href=#874 id=874 data-nosnippet>874</a> }
<a href=#875 id=875 data-nosnippet>875</a>}
</code></pre></div></section></main></body></html>
+30
View File
@@ -0,0 +1,30 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/zeroize-1.8.2/src/x86.rs`."><title>x86.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"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zeroize" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.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-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.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">zeroize/</div>x86.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! [`Zeroize`] impls for x86 SIMD registers
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use crate</span>::{atomic_fence, volatile_write, Zeroize};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="attr">#[cfg(target_arch = <span class="string">"x86"</span>)]
<a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">use </span>core::arch::x86::<span class="kw-2">*</span>;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="attr">#[cfg(target_arch = <span class="string">"x86_64"</span>)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>core::arch::x86_64::<span class="kw-2">*</span>;
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="macro">macro_rules!</span> impl_zeroize_for_simd_register {
<a href=#12 id=12 data-nosnippet>12</a> ($(<span class="macro-nonterminal">$type</span>:ty),* $(,)<span class="question-mark">?</span>) =&gt; {
<a href=#13 id=13 data-nosnippet>13</a> $(
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">impl </span>Zeroize <span class="kw">for </span><span class="macro-nonterminal">$type </span>{
<a href=#15 id=15 data-nosnippet>15</a> <span class="attr">#[inline]
<a href=#16 id=16 data-nosnippet>16</a> </span><span class="kw">fn </span>zeroize(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#17 id=17 data-nosnippet>17</a> volatile_write(<span class="self">self</span>, <span class="kw">unsafe </span>{ core::mem::zeroed() });
<a href=#18 id=18 data-nosnippet>18</a> atomic_fence();
<a href=#19 id=19 data-nosnippet>19</a> }
<a href=#20 id=20 data-nosnippet>20</a> }
<a href=#21 id=21 data-nosnippet>21</a> )*
<a href=#22 id=22 data-nosnippet>22</a> };
<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="macro">impl_zeroize_for_simd_register!</span>(__m128, __m128d, __m128i, __m256, __m256d, __m256i);
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="comment">// NOTE: MSRV 1.72
<a href=#28 id=28 data-nosnippet>28</a></span><span class="attr">#[cfg(feature = <span class="string">"simd"</span>)]
<a href=#29 id=29 data-nosnippet>29</a></span><span class="macro">impl_zeroize_for_simd_register!</span>(__m512, __m512d, __m512i);
</code></pre></div></section></main></body></html>