Struct Emulator

pub struct Emulator { /* private fields */ }

Available on crate feature sms only.

A SEGA Master System / GameGear emulator that the auto splitter is attached to.

Implementations

impl Emulator

pub fn attach() -> Option<Self>

Attaches to the emulator process

Returns Option<T> if successful, None otherwise.

Supported emulators are:

• Retroarch, with one of the following cores: genesis_plus_gx_libretro.dll, genesis_plus_gx_wide_libretro.dll, picodrive_libretro.dll, smsplus_libretro.dll, gearsystem_libretro.dll
• Fusion
• BlastEm

pub async fn wait_attach() -> Self

Asynchronously awaits attaching to a target emulator, yielding back to the runtime between each try.

Supported emulators are:

• Retroarch, with one of the following cores: genesis_plus_gx_libretro.dll, genesis_plus_gx_wide_libretro.dll, picodrive_libretro.dll, smsplus_libretro.dll, gearsystem_libretro.dll
• Fusion
• BlastEm

pub fn is_open(&self) -> bool

Checks whether the emulator is still open. If it is not open anymore, you should drop the emulator.

pub const fn until_closes<F>(&self, future: F) -> UntilEmulatorCloses<'_, F>

Executes a future until the emulator process closes.

pub fn update(&self) -> bool

Calls the internal routines needed in order to find (and update, if needed) the address of the emulated RAM.

Returns true if successful, false otherwise.

pub fn get_address(&self, offset: u32) -> Result<Address, Error>

Converts a SEGA Master System memory address to a real memory address in the emulator process’ virtual memory space

Valid addresses for the SMS range from 0xC000 to 0xDFFF.

pub fn read<T: CheckedBitPattern>(&self, offset: u32) -> Result<T, Error>

Reads any value from the emulated RAM.

The offset provided is meant to be the same used on the original hardware.

The SEGA Master System has 8KB of RAM, mapped from address 0xC000 to 0xDFFF.

Providing any offset outside this range will return Err().