gma 1.0.0

read and write .gma files, the format used by garry's mods addons
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

use crate::binary;
use lzma_rs;
use std::fmt::Display;

#[derive(Debug)]
pub enum Error {
    IOError(std::io::Error),
    /// this is likely due to trying to write a string containing a null byte
    InvalidString,
    UTF8Error(std::string::FromUtf8Error),
    /// The byte sequence 'GMAD' is expected at the start of every .gma file
    InvalidIdent,
    /// As of writting this only version 1,2 and 3 of the file format are supported
    InvalidVersion(u8),
    CompressionError(lzma_rs::error::Error),
    InvalidAddonType(String),
    InvalidAddonTag(String),
}

impl From<std::io::Error> for Error {
    fn from(e: std::io::Error) -> Self {
        Self::IOError(e)
    }
}

impl From<std::string::FromUtf8Error> for Error {
    fn from(e: std::string::FromUtf8Error) -> Self {
        Self::UTF8Error(e)
    }
}

impl From<binary::Error> for Error {
    fn from(e: binary::Error) -> Self {
        match e {
            binary::Error::IOError(e) => Self::IOError(e),
            binary::Error::InvalidUTF8(e) => Self::UTF8Error(e),
            binary::Error::InvalidCString => Self::InvalidString,
        }
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::IOError(e) => e.fmt(f),
            Self::InvalidString => write!(f, "An invalid string was found, strings cant have the null byte and should only contain ascii characters"),
            Self::UTF8Error(e) => e.fmt(f),
            Self::InvalidIdent => write!(f, "The gma file did not containt a valid ident, 'GMAD' was expect at the start of the file"),
            Self::InvalidVersion(v) => write!(f, "An invalid version of gma file was found : '{}', this might be cause by a corrupt file", v),
            Self::CompressionError(e) => write!(f, "Error while compressing/decompressing. {:?}", e),
            Self::InvalidAddonType(s) => write!(f, "The addon type '{}' is invalid.", s),
            Self::InvalidAddonTag(s) => write!(f, "The addon tag '{}' is invalid.", s),
        }
    }
}

impl std::error::Error for Error {}