Struct spectrusty_formats::ay::AyFile

pub struct AyFile {
    pub raw: Box<[u8]>,
    pub meta: AyMeta,
    pub songs: Box<[AySong]>,
    /* private fields */
}

This type is being ever created only as PinAyFile to prevent destructing and moving data out.

The AyFile struct uses pointers referencing self-owned data under the hood. Users may inspect its content safely and initialize the player with it. See: AyFile::initialize_player.

This struct can’t be used to construct AY files.

Fields

raw: Box<[u8]>

The original parsed data owned by this struct.

meta: AyMeta

AY file meta-data.

songs: Box<[AySong]>

The list of AY songs.

Implementations

impl AyFile

pub fn initialize_player<C, M>(
    &self,
    cpu: &mut C,
    memory: &mut M,
    song_index: usize
)where
    C: Cpu,
    M: ZxMemory,

Initializes memory and the cpu registers, creates a player routine, and loads song data into memory. Provide song_index of the desired song from this file to be played.

Panics

• If song_index is larger or equal to the number of contained songs. You may get the number of songs by invoking .songs.len() method.
• If a special player is required. See AyMeta.
• If the capacity of provided memory is less than 64kb.

Trait Implementations

impl Debug for AyFile

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

Formats the value using the given formatter.