alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-24 00:31:34 +11:00
Code Issues Packages Projects Releases Wiki Activity

add some doc comments to explain the allocators

Browse source
This commit is contained in:
Corwin 2022-07-30 19:34:40 +01:00
parent feea7d2af1
commit 7f760d4404
1 changed files with 40 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
agb/src/agb_alloc/mod.rs
View file

@ -43,7 +43,47 @@ static GLOBAL_ALLOC: BlockAllocator = unsafe {
})
};
/// This is the allocator for the External Working Ram. This is currently
/// equivalent to the Global Allocator (where things are allocated if no allocator is provided). This implements the allocator trait, so
/// is meant to be used in specifying where certain structures should be
/// allocated.
///
/// ```rust,no_run
/// # #![no_std]
/// # #![no_main]
/// # use crate::EWRAM_ALLOC;
/// # extern crate alloc;
/// # use alloc::vec::Vec;
/// # fn foo(gba: &mut agb::Gba) {
/// let mut v = Vec::new_in(EWRAM_ALLOC);
/// v.push("hello, world");
/// assert!(
/// (0x0200_0000..0x0204_0000).contains(&(v.as_ptr() as usize)),
/// "the address of the vector is inside ewram"
/// );
/// # }
/// ```
pub static EWRAM_ALLOC: &BlockAllocator = &GLOBAL_ALLOC;
/// This is the allocator for the Internal Working Ram. This implements the
/// allocator trait, so is meant to be used in specifying where certain
/// structures should be allocated.
///
/// ```rust,no_run
/// # #![no_std]
/// # #![no_main]
/// # use crate::IWRAM_ALLOC;
/// # extern crate alloc;
/// # use alloc::vec::Vec;
/// # fn foo(gba: &mut agb::Gba) {
/// let mut v = Vec::new_in(IWRAM_ALLOC);
/// v.push("hello, world");
/// assert!(
/// (0x0300_0000..0x0200_8000).contains(&(v.as_ptr() as usize)),
/// "the address of the vector is inside iwram"
/// );
/// # }
/// ```
pub static IWRAM_ALLOC: &BlockAllocator = &__IWRAM_ALLOC;
static __IWRAM_ALLOC: BlockAllocator = unsafe {
BlockAllocator::new(StartEnd {