espers 0.1.0

Library for reading ESP and ESM files
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
93
94
95
96

use crate::common::FormID;
use crate::error::Error;
use crate::fields::{CNAM, DATA, HEDR, INCC, INTV, MAST, ONAM, SNAM};
use binrw::{binrw, io::Cursor, BinRead};
use bitflags::bitflags;
use serde_derive::{Deserialize, Serialize};

bitflags! {
    #[binrw]
    #[derive(Serialize, Deserialize)]
    pub struct TES4Flags: u32 {
        const MASTER = 0x00000001;
        const LOCALIZED = 0x00000080;
        const LIGHT_MASTER = 0x00000200;
    }
}

#[binrw]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[brw(little, magic = b"TES4")]
pub struct TES4 {
    pub size: u32,
    pub flags: TES4Flags,
    pub form_id: u32,
    pub timestamp: u16,
    pub version_control: u16,
    pub internal_version: u16,
    pub unknown: u16,
    #[br(count = size)]
    pub data: Vec<u8>,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Header {
    pub tes4: TES4,
    pub header: HEDR,
    pub author: Option<String>,
    pub description: Option<String>,
    pub masters: Vec<String>,
    pub overrides: Vec<FormID>,
    pub tagifiable_strings_count: u32,
    pub counter: Option<u32>,
}

impl TryFrom<TES4> for Header {
    type Error = Error;

    fn try_from(raw: TES4) -> Result<Self, Self::Error> {
        let mut cursor = Cursor::new(&raw.data);

        let header = HEDR::read(&mut cursor)?;
        let author = CNAM::read(&mut cursor)
            .ok()
            .map(TryInto::try_into)
            .transpose()?;
        let description = SNAM::read(&mut cursor)
            .ok()
            .map(TryInto::try_into)
            .transpose()?;
        let mut masters = Vec::new();

        loop {
            match MAST::read(&mut cursor) {
                Ok(m) => masters.push(m.try_into()?),
                Err(_) => break,
            }
            match DATA::read(&mut cursor) {
                Ok(_) => {}
                Err(_) => break,
            }
        }

        let overrides = ONAM::read(&mut cursor)
            .ok()
            .map(TryInto::try_into)
            .transpose()?
            .unwrap_or_default();

        let tagifiable_strings_count = INTV::read(&mut cursor)?.try_into()?;
        let counter = INCC::read(&mut cursor)
            .ok()
            .map(TryInto::try_into)
            .transpose()?;

        Ok(Self {
            tes4: raw,
            header,
            author,
            description,
            masters,
            overrides,
            tagifiable_strings_count,
            counter,
        })
    }
}