sfc_cart 0.3.1

SNES/SFC ROM header library and utilities.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR MPL-2.0
// SPDX-FileCopyrightText: 2026 Gabriel Marcano <gabemarcano@yahoo.com>

use crate::error::Error;
use crate::metadata::Metadata;
use crate::metadata::MetadataRead;

use std::io;
use std::io::Read;
use std::io::Seek;
use std::io::SeekFrom;

/// Represents a Cart object that can be read from.
pub struct Cart<T: Read + Seek> {
    pub metadata: Metadata,
    io: T,
}

impl<T: Read + Seek> Cart<T> {
    /// Creates a [`Cart`] from the given IO object.
    ///
    /// # Errors
    ///
    /// See [`MetadataRead::read_sfc_metadata`] for details.
    pub fn try_from(io: T) -> Result<Self, Error> {
        let mut io = io;
        Ok(Self {
            metadata: io.read_sfc_metadata()?,
            io,
        })
    }

    /// Consumes the [`Cart`] and returns its internal data.
    pub fn release(self) -> (Metadata, T) {
        (self.metadata, self.io)
    }

    /// Computes the checksum of the [`Cart`].
    ///
    /// # Errors
    ///
    /// See [`Metadata::compute_checksum`] for details.
    pub fn checksum(&mut self) -> Result<u16, Error> {
        let mut io = &mut self.io;
        self.metadata.compute_checksum(&mut io)
    }
}

impl<T: Read + Seek> Read for Cart<T> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.io.read(buf)
    }
}

impl<T: Read + Seek> Seek for Cart<T> {
    fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
        self.io.seek(pos)
    }
}