Struct InternalAllocator

pub struct InternalAllocator;

This is the allocator for Internal Working RAM.

Internal Working RAM (IWRAM) is the fastest RAM on the Game Boy Advance but is also the very limited in quantity (32kb). The default allocator for agb is the ExternalAllocator which allocates into External Working RAM (EWRAM). EWRAM is more plentiful (256kb), so you should prefer to allocate into that and only allocate into IWRAM if you have specific cases you need to be faster.

This implements the allocator trait, so is meant to be used in specifying where certain structures should be allocated.

#![feature(allocator_api)]
extern crate alloc;

use agb::InternalAllocator;
use alloc::vec::Vec;

let mut v = Vec::new_in(InternalAllocator);
v.push("hello, world");
assert!(
    (0x0300_0000..0x0300_8000).contains(&(v.as_ptr() as usize)),
    "the address of the vector is inside iwram"
);

Trait Implementations

impl Allocator for InternalAllocator

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

🔬This is a nightly-only experimental API. (allocator_api)

Attempts to allocate a block of memory.

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

🔬This is a nightly-only experimental API. (allocator_api)

Deallocates the memory referenced by ptr.

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

🔬This is a nightly-only experimental API. (allocator_api)

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

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

🔬This is a nightly-only experimental API. (allocator_api)

Attempts to extend the memory block.

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

🔬This is a nightly-only experimental API. (allocator_api)

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>

🔬This is a nightly-only experimental API. (allocator_api)

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

🔬This is a nightly-only experimental API. (allocator_api)

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

impl Clone for InternalAllocator

fn clone(&self) -> InternalAllocator

Returns a duplicate of the value.

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

Performs copy-assignment from source.