Skip to content

Commit

Permalink
revised docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nstilt1 committed Jan 23, 2024
1 parent 9961905 commit 4524200
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions zeroize/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -796,9 +796,10 @@ unsafe fn volatile_set<T: Copy + Sized>(dst: *mut T, src: T, count: usize) {
}

/// Zeroizes a flat type/struct. Only zeroizes the values that it owns, and it does not work on
/// dynamically sized values or trait objects.
/// dynamically sized values or trait objects. Do not use this function on a type that already
/// implements `ZeroizeOnDrop`.
///
/// ## Safety:
/// # Safety:
/// - The type must not contain references to outside data or dynamically sized data
/// - This function can invalidate the type if it is used after this function is called on it. It is
/// advisable to call this method in `impl Drop`.
Expand Down

0 comments on commit 4524200

Please sign in to comment.