Struct HramArea 

pub struct HramArea<const N: usize>(/* private fields */);

A raw, fixed-size region of High RAM, addressed through pointers.

The home for a routine that must execute from HRAM (an OAM DMA trampoline) or a scratch buffer. Declare it with hram!. HRAM is NOLOAD, so the runtime zero-initialises it at startup; fill it at runtime.

Implementations

impl<const N: usize> HramArea<N>

pub const unsafe fn uninit() -> HramArea<N>

Reserve an area.

Safety

The area must come to rest in High RAM (0xFF80..=0xFFFE); hram! guarantees this.

pub const fn as_ptr(&self) -> *const u8

A pointer to the start of the area.

pub const fn as_mut_ptr(&self) -> *mut u8

A mutable pointer to the start of the area.

pub const fn as_array_ptr(&self) -> *mut [u8; N]

A mutable pointer to the area as a fixed-size byte array.

pub const fn len(&self) -> usize

The area’s length in bytes (N).

pub const fn is_empty(&self) -> bool

Whether the area is zero bytes.

Trait Implementations

impl<const N: usize> Sync for HramArea<N>