Struct Allocator 

pub struct Allocator;

An allocator.

Implementations

impl Allocator

pub fn lock()

Locks a collector.

pub fn unlock()

Unlocks a collector.

pub unsafe fn initialize()

Initializes a collector.

Safety

This function must be called in a main thread.

pub unsafe fn register_current_thread() -> Result<(), Error>

Registers a current thread to a collector.

Safety

This function must not be called in a main thread.

pub unsafe fn set_stack_bottom(bottom: *const u8)

Sets a bottom of a stack.

You do not have to call this function in most cases. A collector detects the bottom on initialization automatically.

Safety

The bottom address must be valid.

pub unsafe fn unregister_current_thread()

Unregisters a current thread from a collector.

Safety

The thread must be registered already.

pub fn force_collect()

Runs a garbage collection forcibly.

pub unsafe fn register_finalizer( ptr: *const c_void, finalizer: extern "C" fn(*mut c_void, *mut c_void), client_data: *const c_void, )

Registers a finalizer of an object.

Safety

The given finalizer must not be null and handle pointers properly.

Trait Implementations

impl GlobalAlloc for Allocator

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout.

unsafe fn realloc(&self, ptr: *mut u8, _layout: Layout, size: usize) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned.