wt_blk 0.2.0

Parser and unpacker for the BLK file format
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

use crate::blk::error::ParseError;

#[repr(u8)]
#[allow(non_camel_case_types)]
#[derive(Debug, Ord, PartialOrd, Eq, PartialEq, Hash, Copy, Clone, strum::Display)]
// BLK file type, always first byte of file
pub enum FileType {
	/// Unknown and unsupported
	BBF           = 0x00,
	/// BLK file with integrated name-map, no external map is required
	FAT           = 0x01,
	/// Same as FAT but with ZSTD compression
	FAT_ZSTD      = 0x02,
	/// Has name map externally stored
	SLIM          = 0x03,
	/// Same as SLIM but ZSTD compressed
	SLIM_ZSTD     = 0x04,
	/// Same as SLIM_ZSTD, but with a ZSTD dictionary
	SLIM_ZST_DICT = 0x05,
}

impl FileType {
	pub fn from_byte(input: u8) -> Result<Self, ParseError> {
		match input {
			0x00 => Ok(Self::BBF),
			0x01 => Ok(Self::FAT),
			0x02 => Ok(Self::FAT_ZSTD),
			0x03 => Ok(Self::SLIM),
			0x04 => Ok(Self::SLIM_ZSTD),
			0x05 => Ok(Self::SLIM_ZST_DICT),
			_ => Err(ParseError::UnrecognizedBlkHeader { header: input }),
		}
	}

	pub fn is_slim(&self) -> bool {
		match self {
			FileType::SLIM => true,
			FileType::SLIM_ZSTD => true,
			FileType::SLIM_ZST_DICT => true,
			_ => false,
		}
	}

	pub fn is_zstd(&self) -> bool {
		match self {
			FileType::FAT_ZSTD => true,
			FileType::SLIM_ZSTD => true,
			FileType::SLIM_ZST_DICT => true,
			_ => false,
		}
	}

	pub fn needs_dict(&self) -> bool {
		*self == FileType::SLIM_ZST_DICT
	}
}