wolfrpg-map-parser 0.6.0

Parser for Wolf RPG Editor map 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

use crate::db_parser::game_data::GameData;
use crate::db_parser::DATA_MAGIC;
use std::fs;
use std::io::Result;
use std::path::Path;

/// Parse a .dat file containing information on a WolfRPG Editor game.
///
/// Returns miscellaneous data regarding the game.
/// If you have already read the bytes, consider using [`parse_bytes`].
///
/// # Panics
/// This function will panic if the given file does not represent a valid game data structure.
pub fn parse(data: &Path) -> Result<GameData> {
    match fs::read(data) {
        Ok(contents) => {
            Ok(parse_bytes(&contents))
        }
        Err(e) => {
            Err(e)
        }
    }
}

/// Parse bytes containing information on a WolfRPG Editor game.
///
/// Returns miscellaneous data regarding the game.
/// If you need to read the file to call this function, consider using [`parse`].
///
/// # Panics
/// This function will panic if the given bytes do not represent a valid game data structure.
pub fn parse_bytes(bytes: &[u8]) -> GameData {
    let mut offset: usize = 0;

    let header: &[u8] = &bytes[0..11];
    offset += 11;

    if &header[..10] != DATA_MAGIC {
        panic!("Invalid data header.");
    }

    offset += 3; // Padding

    GameData::parse(&bytes[offset..])
}