nms-save 0.2.0

Raw binary save file parser for No Man's Sky (LZ4, XXTEA, key deobfuscation)
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

//! Error types for save file parsing.

/// Error returned by save file decompression and parsing operations.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum SaveError {
    /// Block header magic mismatch.
    #[error("invalid block magic at offset {offset:#x}: expected 0xFEEDA1E5, found {found:#010x}")]
    InvalidMagic { offset: usize, found: u32 },

    /// LZ4 decompression failed for a block.
    #[error("LZ4 decompression failed at offset {offset:#x}: {message}")]
    DecompressionFailed { offset: usize, message: String },

    /// File ended before the expected number of bytes could be read.
    #[error("unexpected EOF at offset {offset:#x}: needed {expected} more bytes")]
    UnexpectedEof { offset: usize, expected: usize },

    /// A block's decompressed_size exceeds the maximum chunk size.
    #[error(
        "block at offset {offset:#x} declares decompressed size {declared}, exceeds max 0x80000"
    )]
    ChunkTooLarge { offset: usize, declared: u32 },

    /// Metadata file has an invalid length (not one of the known sizes).
    #[error("invalid metadata file length: {length} bytes")]
    InvalidMetaLength { length: usize },

    /// Metadata decryption failed -- magic sentinel not found after trying all slots.
    #[error("metadata decryption failed: magic sentinel not found")]
    MetaDecryptionFailed,

    /// Metadata format version is unsupported (e.g., 2000/vanilla).
    #[error("unsupported metadata format version: {version:#x}")]
    UnsupportedMetaFormat { version: u32 },

    /// SHA-256 verification failed.
    #[error("SHA-256 mismatch")]
    Sha256Mismatch {
        expected: [u8; 32],
        actual: [u8; 32],
    },

    /// Failed to parse a mapping JSON file.
    #[error("mapping parse error: {message}")]
    MappingParseError { message: String },

    /// Failed to parse save JSON.
    #[error("JSON parse error: {message}")]
    JsonParseError { message: String },

    /// Wrapper for std::io::Error (file I/O).
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
}