Struct TESGlobalAlloc

pub struct TESGlobalAlloc;

The Skyrim global memory allocator using MemoryManager C++ class.

It implements Allocator and GlobalAlloc, so it can be used for #[global_allocator] and other Allocator changeable arrays.

Note: while this type is unstable, the functionality it provides can be accessed through the free functions in alloc.

CI

Skyrim MemoryManager is not available for CI, Therefore, the test_on_ci feature is enabled, it will automatically fall back to Rust’s Global.

Trait Implementations

impl Allocator for TESGlobalAlloc

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Attempts to allocate a block of memory.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn deallocate(&self, ptr: NonNull<u8>, layout: Layout)

Deallocates the memory referenced by ptr.

unsafe fn grow( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

unsafe fn shrink( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Allocator.

impl Clone for TESGlobalAlloc

fn clone(&self) -> TESGlobalAlloc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TESGlobalAlloc

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

Formats the value using the given formatter.

impl Default for TESGlobalAlloc

fn default() -> TESGlobalAlloc

Returns the “default value” for a type.

impl GlobalAlloc for TESGlobalAlloc

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, new_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.

impl PartialEq for TESGlobalAlloc

fn eq(&self, other: &TESGlobalAlloc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SelflessAllocator for TESGlobalAlloc

fn allocate(layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Allocates a block of memory described by the given layout.

fn allocate_zeroed(layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Allocates zero-initialized memory.

unsafe fn deallocate(ptr: NonNull<u8>, layout: Layout)

Deallocates a previously allocated block of memory.

unsafe fn grow( ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Grows a memory block to a new layout.

unsafe fn grow_zeroed( ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Grows and zero-initializes additional memory beyond the old size.

unsafe fn shrink( ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to shrink a memory block to a smaller size.

impl StructuralPartialEq for TESGlobalAlloc