Struct winsafe::guard::HeapFreeGuard

pub struct HeapFreeGuard<'a, H>
where
    H: kernel_Hheap,
{ /* private fields */ }

Available on crate feature kernel only.

RAII implementation for the memory allocated by HHEAP::HeapAlloc which automatically calls HeapFree when the object goes out of scope.

Implementations

impl<'a, H> HeapFreeGuard<'a, H>

where H: kernel_Hheap,

pub const unsafe fn new(hheap: &'a H, pmem: *mut c_void, sz: usize) -> Self

Constructs the guard by taking ownership of the handle.

Safety

Be sure the handle must be freed with HeapFree at the end of scope, the pointer is valid, and the size is correct.

pub fn leak(&mut self) -> (*mut c_void, usize)

Ejects the underlying memory pointer and size, leaving null and zero in their places.

Since the internal memory pointer will be invalidated, the destructor will not run. It’s your responsibility to run it, otherwise you’ll cause a memory leak.

pub const fn as_ptr(&self) -> *const c_void

Returns a pointer to the allocated memory block, or null if not allocated.

pub fn as_mut_ptr(&mut self) -> *mut c_void

Returns a mutable pointer to the allocated memory block, or null if not allocated.

pub const fn as_slice(&self) -> &[u8]

Returns a slice over the allocated memory block.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns a mutable slice over the allocated memory block.

pub const unsafe fn as_slice_aligned<T>(&self) -> &[T]

Returns a slice over the allocated memory block, aligned to the given type.

Safety

Make sure the alignment is correct.

pub unsafe fn as_mut_slice_aligned<T>(&mut self) -> &mut [T]

Returns a mutable slice over the allocated memory block, aligned to the given type.

Safety

Make sure the alignment is correct.

pub const fn len(&self) -> usize

Returns the size of the allocated memory block.

Trait Implementations

impl<'a, H> Drop for HeapFreeGuard<'a, H>

where H: kernel_Hheap,

fn drop(&mut self)

Executes the destructor for this type.