merlon 1.3.1

Mod package manager for the Paper Mario (N64) decompilation
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
60
61
62
63
64
65
66
67
68
69
70
71

//! ROM file handling

use std::io::prelude::*;
use std::path::{Path, PathBuf};
use std::fs::File;
use std::fmt;
use sha1::{Sha1, Digest};
use anyhow::Result;
use pyo3::prelude::*;

/// An N64 ROM file on disk.
#[derive(Debug)]
#[pyclass(module = "merlon.rom")]
pub struct Rom {
    path: PathBuf,
}

#[pymethods]
impl Rom {
    /// Returns the path to the ROM file.
    #[getter]
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Reads the ROM file into a [`Vec`] of bytes.
    pub fn read_bytes(&self) -> std::io::Result<Vec<u8>> {
        let mut file = self.file()?;
        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer)?;
        Ok(buffer)
    }
    
    /// Calculates the SHA1 hash of the ROM.
    pub fn sha1_string(&self) -> Result<String> {
        let mut bytes = self.read_bytes()?;
        let generic_arr = Sha1::digest(&mut bytes);
        let mut hex = String::new();
        for byte in generic_arr.iter() {
            hex.push_str(&format!("{:02x}", byte));
        }
        Ok(hex)
    }

    fn __str__(&self) -> String {
        format!("{}", self)
    }
}

impl Rom {
    /// Returns the ROM as a [`File`].
    pub fn file(&self) -> std::io::Result<File> {
        File::open(self.path())
    }
}

impl From<PathBuf> for Rom {
    fn from(path: PathBuf) -> Self {
        Self { path }
    }
}

impl fmt::Display for Rom {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.path().display())?;
        if let Ok(sha1) = self.sha1_string() {
            write!(f, " (SHA1: {})", sha1)?;
        }
        Ok(())
    }
}