Struct Ghost 

pub struct Ghost { /* private fields */ }

A fully parsed Mario Kart Wii RKG ghost file.

Holds the file header, decompressed or compressed input data, optional external footers (CTGP or SP), and CRC-32 checksums. All setter operations update the parsed fields; call update_raw_data (or save_to_file, which calls it implicitly) to flush all changes back into the raw byte buffer before writing.

Implementations

impl Ghost

pub fn new_from_file<T: AsRef<Path>>(path: T) -> Result<Self, GhostError>

Parses a Ghost from an RKG file at the given path.

Errors

Returns GhostError::IOError if the file cannot be opened or read, and other GhostError variants if parsing fails.

pub fn new(bytes: &[u8]) -> Result<Self, GhostError>

Parses a Ghost from a byte slice.

Detects and parses an optional CTGP or SP footer if present. The base CRC-32 is read from just before the footer when one is found, or from the last 4 bytes of the file otherwise.

Errors

Returns GhostError::DataLengthTooShort if bytes is shorter than 0x90 bytes OR input data is shorter than the expected input data size. Returns other GhostError variants if any field fails to parse.

pub fn update_raw_data(&mut self) -> Result<(), GhostError>

Flushes all parsed field modifications back into the raw byte buffer.

This method recomputes the Mii CRC-16, rebuilds the raw buffer from the current header and input data, resizes the buffer if the input data length has changed, re-inserts any preserved external footer, and finally recomputes both the base CRC-32 and the file-level CRC-32. The CTGP footer SHA-1 field is also updated if a CTGP footer is present.

Errors

Returns GhostError::MiiError if the Mii data is invalid, or GhostError::CTGPFooterError if the SHA-1 field cannot be written.

pub fn save_to_file<T: AsRef<Path>>( &mut self, path: T, ) -> Result<(), GhostError>

Flushes all modifications and writes the ghost to a file at the given path.

Errors

Returns any error from update_raw_data or from file creation/writing.

pub fn compress_input_data(&mut self)

Compresses the input data using Yaz1 encoding and sets the compression flag in the header.

Does nothing if the input data is already compressed.

pub fn decompress_input_data(&mut self)

Decompresses the input data and clears the compression flag in the header.

Does nothing if the input data is not compressed.

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

Returns the raw file bytes.

May not reflect recent modifications until update_raw_data is called.

pub fn raw_data_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the raw file bytes.

pub fn header(&self) -> &Header

Returns the parsed RKG file header.

pub fn header_mut(&mut self) -> &mut Header

Returns a mutable reference to the parsed RKG file header.

pub fn input_data(&self) -> &InputData

Returns the ghost’s controller input data.

pub fn input_data_mut(&mut self) -> &mut InputData

Returns a mutable reference to the ghost’s controller input data.

pub fn footer(&self) -> Option<&FooterType>

Returns the footer, if present.

pub fn footer_mut(&mut self) -> Option<&mut FooterType>

Returns a mutable reference to the footer, if present.

pub fn base_crc32(&self) -> u32

Returns the CRC-32 of the header and input data, excluding any external footer.

pub fn verify_base_crc32(&self) -> bool

Returns true if the stored base CRC-32 matches a freshly computed checksum of the current header and input data bytes.

pub fn file_crc32(&self) -> u32

Returns the CRC-32 of the entire file excluding its final 4 bytes.

pub fn verify_file_crc32(&self) -> bool

Returns true if the stored file CRC-32 matches a freshly computed checksum of the entire file excluding its final 4 bytes.

pub fn should_preserve_external_footer(&self) -> bool

Returns whether an existing external footer will be preserved when saving.

pub fn set_should_preserve_external_footer(&mut self, b: bool)

Sets whether an existing external footer should be preserved when saving.