Struct SafeOwnedMemZero

pub struct SafeOwnedMemZero(/* private fields */);

Handle for zeroing owned memory. “Owned” in this context refers to memory that has been allocated and stored in some kind of char ** argument in the context of C FFI. This means that the memory has been allocated by standard C allocators and needs to be cleaned up by the caller. In the context of Rust, we would consider this owned by the current scope.

SECURITY WARNING

Any pointer used with this must point to memory allocated by libc::malloc or any other function compatible with libc::free. If it has not been, you could cause memory corruption and security problems.

Implementations

impl SafeOwnedMemZero

pub unsafe fn from_ptr(ptr: *mut c_void, size: usize) -> Self

Construct a safe memory handle from a pointer and a size.

Safety

The pointer must point to memory allocated by libc::malloc or something compatible with libc::free. See the struct-level security warning for more information. The size argument also must match the length of the allocated block or memory corruption could occur.

Trait Implementations

impl AsMut<[u8]> for SafeOwnedMemZero

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for SafeOwnedMemZero

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Drop for SafeOwnedMemZero

fn drop(&mut self)

Executes the destructor for this type.

impl SafeMemzero for SafeOwnedMemZero

fn safe_memzero(&mut self)

Zero the data in the buffer. To enable managed zeroing of a buffer, call this in a Drop implementation.