Skip to main content

SaveDevice

Enum SaveDevice 

Source
pub enum SaveDevice {
    None,
    Eeprom(Box<[u8]>),
    Sram(Box<[u8]>),
    Flash(FlashRam),
    ControllerPak(Box<[u8]>),
}
Expand description

A cartridge save backend, sized + typed from the resolved SaveType.

Variants§

§

None

No on-cart save.

§

Eeprom(Box<[u8]>)

Serial EEPROM (joybus), flat backing store (512 B or 2 KiB).

§

Sram(Box<[u8]>)

Battery SRAM (PI DOM2), flat 32 KiB.

§

Flash(FlashRam)

FlashRAM (PI DOM2), the erase/program/status machine.

§

ControllerPak(Box<[u8]>)

Controller Pak (joybus), flat 32 KiB.

Implementations§

Source§

impl SaveDevice

Source

pub fn new(save_type: SaveType) -> Self

Construct the backend for a resolved save type (erased/zeroed state).

Source

pub fn pi_read(&self, addr: u32) -> Option<u8>

PI-bus read (SRAM / FlashRAM) at PI address addr. Returns None for a backend not on the PI bus, so the caller can fall through to open bus.

Source

pub fn pi_write(&mut self, addr: u32, val: u8)

PI-bus write (SRAM / FlashRAM). The FlashRAM CIR at 0x0801_0000 is a 32-bit command; the Bus assembles the word and calls Self::flash_cir.

Source

pub fn flash_cir(&mut self, cmd: u32)

Write the FlashRAM Command Internal Register (a whole 32-bit word).

Source

pub fn eeprom_read_block(&self, block: u8, out: &mut [u8; 8])

Joybus EEPROM read of an 8-byte block (block index) into out.

Source

pub fn eeprom_write_block(&mut self, block: u8, data: &[u8; 8])

Joybus EEPROM write of an 8-byte block.

Source

pub fn cpak_read(&self, addr: u16, out: &mut [u8; 32])

Joybus Controller-Pak read of a 32-byte block at addr (byte offset).

Source

pub fn cpak_write(&mut self, addr: u16, data: &[u8; 32])

Joybus Controller-Pak write of a 32-byte block at addr.

Source

pub fn backing(&self) -> &[u8]

The persistable backing bytes (for the host save file). FlashRAM exposes its data array; the others their flat store. Empty for Self::None.

Trait Implementations§

Source§

impl Clone for SaveDevice

Source§

fn clone(&self) -> SaveDevice

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SaveDevice

Source§

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

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

impl Default for SaveDevice

Source§

fn default() -> SaveDevice

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

impl<'de> Deserialize<'de> for SaveDevice

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SaveDevice

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,