quake-files 0.1.0

A library for reading, writing and converting Quake 1 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

//! Defines error and result types for this library.

use std::io;
use walkdir;

/// Result of most things in this library that use IO or can fail for other reasons.
pub type QResult<T> = Result<T, QError>;

/// Error types.
#[derive(Debug)]
pub enum QError {
    /// See `std::io::Error`.
    IoError(io::Error),
    /// Invalid LMP file.
    InvalidLmp,
    /// Palette bigger than 256 colors
    InvalidPaletteSize,
    /// Wrong magic bytes in the file header.
    BadMagicBytes,
    /// Invalid filename for a PAK file.
    BadFileName,
    /// Unable to find the given file in the PAK.
    FileNotFound,
    /// See `walkdir::Error`.
    WalkDirError(walkdir::Error),
    /// Palette does not contain given color.
    ColorNotInPalette,
}

impl From<io::Error> for QError {
    fn from(err: io::Error) -> QError {
        QError::IoError(err)
    }
}

impl From<walkdir::Error> for QError {
    fn from(err: walkdir::Error) -> QError {
        QError::WalkDirError(err)
    }
}