halbu 0.3.0

Diablo II save file parsing library.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Items section placeholder support.
//!
//! Item payload is preserved as raw bytes.
//! If raw bytes are empty, encoding emits a known empty-inventory trailer for the target layout.

use serde::{Deserialize, Serialize};
use serde_with::{serde_as, Bytes};

const V99_EMPTY_ITEMS_CLASSIC: [u8; 4] = [0x4A, 0x4D, 0x00, 0x00];
const V99_EMPTY_ITEMS_EXPANSION: [u8; 13] =
    [0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x6B, 0x66, 0x00];
const V99_EMPTY_ITEMS_EXPANSION_MERC: [u8; 17] = [
    0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x4A, 0x4D, 0x00, 0x00, 0x6B, 0x66,
    0x00,
];

const V105_EMPTY_ITEMS_CLASSIC: [u8; 4] = [0x4A, 0x4D, 0x00, 0x00];
const V105_EMPTY_ITEMS_EXPANSION: [u8; 13] =
    [0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x6B, 0x66, 0x00];
const V105_EMPTY_ITEMS_EXPANSION_MERC: [u8; 17] = [
    0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x4A, 0x4D, 0x00, 0x00, 0x6B, 0x66,
    0x00,
];
const V105_EMPTY_ITEMS_ROTW: [u8; 19] = [
    0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x6B, 0x66, 0x00, 0x01, 0x00, 0x6C,
    0x66, 0x00, 0x00,
];

const V105_EMPTY_ITEMS_ROTW_MERC: [u8; 23] = [
    0x4A, 0x4D, 0x00, 0x00, 0x4A, 0x4D, 0x00, 0x00, 0x6A, 0x66, 0x4A, 0x4D, 0x00, 0x00, 0x6B, 0x66,
    0x00, 0x01, 0x00, 0x6C, 0x66, 0x00, 0x00,
];

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum EmptyLayout {
    /// Legacy D2R classic empty-item trailer.
    LegacyClassic,
    /// Legacy D2R expansion empty-item trailer.
    LegacyExpansion,
    /// V105 classic empty-item trailer.
    V105Classic,
    /// V105 expansion empty-item trailer.
    V105Expansion,
    /// V105 RotW empty-item trailer.
    V105RotW,
}

/// Raw items-section payload placeholder.
#[serde_as]
#[derive(PartialEq, Eq, Debug, Default, Clone, Serialize, Deserialize)]
pub struct Placeholder {
    #[serde_as(as = "Bytes")]
    data: Vec<u8>,
    #[serde(default)]
    original_mercenary_hired: bool,
}

/// Store item bytes without decoding.
pub fn parse(byte_vector: &[u8], mercenary_hired: bool) -> Placeholder {
    Placeholder { data: byte_vector.to_vec(), original_mercenary_hired: mercenary_hired }
}

impl Placeholder {
    pub(crate) fn mercenary_hire_state_changed(&self, mercenary_hired: bool) -> bool {
        self.original_mercenary_hired != mercenary_hired
    }
}

/// Generate item bytes.
///
/// If `placeholder` contains raw bytes, they are returned unchanged.
/// Otherwise, a known empty-item layout trailer is emitted.
pub fn generate(
    placeholder: &Placeholder,
    empty_layout: EmptyLayout,
    mercenary_hired: bool,
) -> Vec<u8> {
    if !placeholder.data.is_empty() {
        return placeholder.data.clone();
    }

    match (empty_layout, mercenary_hired) {
        (EmptyLayout::LegacyClassic, _) => V99_EMPTY_ITEMS_CLASSIC.to_vec(),
        (EmptyLayout::LegacyExpansion, false) => V99_EMPTY_ITEMS_EXPANSION.to_vec(),
        (EmptyLayout::LegacyExpansion, true) => V99_EMPTY_ITEMS_EXPANSION_MERC.to_vec(),
        (EmptyLayout::V105Classic, _) => V105_EMPTY_ITEMS_CLASSIC.to_vec(),
        (EmptyLayout::V105Expansion, false) => V105_EMPTY_ITEMS_EXPANSION.to_vec(),
        (EmptyLayout::V105Expansion, true) => V105_EMPTY_ITEMS_EXPANSION_MERC.to_vec(),
        (EmptyLayout::V105RotW, false) => V105_EMPTY_ITEMS_ROTW.to_vec(),
        (EmptyLayout::V105RotW, true) => V105_EMPTY_ITEMS_ROTW_MERC.to_vec(),
    }
}