Struct leap_sys::LEAP_ALLOCATOR

#[repr(C, packed)]pub struct LEAP_ALLOCATOR {
    pub allocate: Option<unsafe extern "C" fn(size: u32, typeHint: eLeapAllocatorType, state: *mut c_void) -> *mut c_void>,
    pub deallocate: Option<unsafe extern "C" fn(ptr: *mut c_void, state: *mut c_void)>,
    pub state: *mut c_void,
}

\ingroup Structs Specifies the allocator/deallocator functions to be used when the library needs to dynamically manage memory. @since 4.0.0

Fields

allocate: Option<unsafe extern "C" fn(size: u32, typeHint: eLeapAllocatorType, state: *mut c_void) -> *mut c_void>

Function pointer to an allocator function that is expected to return a pointer to memory of at least the specified size in bytes. This will be called when the library needs a block of memory that will be provided back to the client in a subsequent event or response. A type hint is provided in the case where the underlying buffer type needs to be known at allocation time.

deallocate: Option<unsafe extern "C" fn(ptr: *mut c_void, state: *mut c_void)>

Function pointer to a deallocator function. The function receives the address of a previously allocated block of memory from the allocate function pointer. The caller is not required to deallocate the memory, but rather this call is used by the library to indicate to the client that it will no longer reference the memory at this address, and that the callee may deallocate the memory when it is ready to do so.

state: *mut c_void

Pointer to state to be passed to the allocate and deallocate functions.

Trait Implementations

impl Clone for LEAP_ALLOCATOR

fn clone(&self) -> LEAP_ALLOCATOR

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LEAP_ALLOCATOR

impl Debug for LEAP_ALLOCATOR

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.