Skip to main content

MemoryManager

Struct MemoryManager 

Source
pub struct MemoryManager { /* private fields */ }
Expand description

Memory manager for GameCube memory operations.

§Memory Layout

  • ram: 24MB byte array (heap allocation required for large size)

§Address Translation

GameCube main RAM is mapped to virtual addresses 0x80000000-0x817FFFFF. Physical addresses are computed by subtracting the base address (0x80000000).

Implementations§

Source§

impl MemoryManager

Source

pub fn new() -> Self

Create a new memory manager with 24MB of RAM.

§Returns

MemoryManager - Initialized memory manager with all bytes set to 0

§Examples
let mut memory = MemoryManager::new();
Source

pub fn read_u8(&self, address: u32) -> Result<u8>

Read a single byte from memory.

§Arguments
  • address - 32-bit virtual address
§Returns

Result<u8> - Byte value at address, or error if invalid/out of bounds

§Errors

Returns error if address is not in main RAM or out of bounds

§Examples
let value = memory.read_u8(0x80000000)?;
Source

pub fn read_u16(&self, address: u32) -> Result<u16>

Read a 16-bit word (big-endian) from memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
§Returns

Result<u16> - 16-bit value at address, or error if invalid/out of bounds

§Errors

Returns error if address+1 is out of bounds

§Examples
let value = memory.read_u16(0x80000000)?;
Source

pub fn read_u32(&self, address: u32) -> Result<u32>

Read a 32-bit word (big-endian) from memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
§Returns

Result<u32> - 32-bit value at address, or error if invalid/out of bounds

§Errors

Returns error if address+3 is out of bounds

§Examples
let value = memory.read_u32(0x80000000)?;
Source

pub fn read_u64(&self, address: u32) -> Result<u64>

Read a 64-bit word (big-endian) from memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
§Returns

Result<u64> - 64-bit value at address, or error if invalid/out of bounds

§Errors

Returns error if address+7 is out of bounds

§Examples
let value = memory.read_u64(0x80000000)?;
Source

pub fn write_u8(&mut self, address: u32, value: u8) -> Result<()>

Write a single byte to memory.

§Arguments
  • address - 32-bit virtual address
  • value - Byte value to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if address is not in main RAM or out of bounds

§Examples
memory.write_u8(0x80000000, 0x42)?;
Source

pub fn write_u16(&mut self, address: u32, value: u16) -> Result<()>

Write a 16-bit word (big-endian) to memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
  • value - 16-bit value to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if address+1 is out of bounds

§Examples
memory.write_u16(0x80000000, 0x1234)?;
Source

pub fn write_u32(&mut self, address: u32, value: u32) -> Result<()>

Write a 32-bit word (big-endian) to memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
  • value - 32-bit value to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if address+3 is out of bounds

§Examples
memory.write_u32(0x80000000, 0x12345678)?;
Source

pub fn write_u64(&mut self, address: u32, value: u64) -> Result<()>

Write a 64-bit word (big-endian) to memory.

§Arguments
  • address - 32-bit virtual address (must be aligned, but we don’t enforce it)
  • value - 64-bit value to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if address+7 is out of bounds

§Examples
memory.write_u64(0x80000000, 0x1234567890ABCDEF)?;
Source

pub fn read_bytes(&self, address: u32, len: usize) -> Result<Vec<u8>>

Read multiple bytes from memory.

§Arguments
  • address - 32-bit virtual address
  • len - Number of bytes to read
§Returns

Result<Vec<u8>> - Byte vector, or error if invalid/out of bounds

§Errors

Returns error if address+len is out of bounds

§Examples
let data = memory.read_bytes(0x80000000, 1024)?;
Source

pub fn write_bytes(&mut self, address: u32, data: &[u8]) -> Result<()>

Write multiple bytes to memory.

§Arguments
  • address - 32-bit virtual address
  • data - Byte slice to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if address+data.len() is out of bounds

§Examples
memory.write_bytes(0x80000000, &[0x42, 0x43, 0x44])?;
Source

pub fn load_section(&mut self, address: u32, data: &[u8]) -> Result<()>

Load a section of data into memory (convenience wrapper for write_bytes).

§Arguments
  • address - 32-bit virtual address
  • data - Byte slice to write
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Examples
memory.load_section(0x80000000, &section_data)?;
Source

pub fn bulk_copy(&mut self, dest: u32, src: u32, len: usize) -> Result<()>

Optimized bulk memory copy.

§Algorithm

Copies len bytes from src to dest. Uses optimized copy_from_slice for non-overlapping ranges. For overlapping ranges, uses temporary buffer to ensure correct copy semantics.

§Arguments
  • dest - Destination address
  • src - Source address
  • len - Number of bytes to copy
§Returns

Result<()> - Success, or error if invalid/out of bounds

§Errors

Returns error if either address is invalid or copy would go out of bounds

§Examples
memory.bulk_copy(0x80001000, 0x80000000, 1024)?;
Source

pub fn get_slice(&self, address: u32, len: usize) -> Result<&[u8]>

Get a read-only slice of memory.

§Safety

This function is safe but returns a reference to internal memory. The caller must ensure the slice is not used after the MemoryManager is dropped.

§Arguments
  • address - 32-bit virtual address
  • len - Length of slice
§Returns

Result<&[u8]> - Byte slice, or error if invalid/out of bounds

§Errors

Returns error if address+len is out of bounds

§Examples
let slice = memory.get_slice(0x80000000, 1024)?;

Trait Implementations§

Source§

impl Debug for MemoryManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MemoryManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.