ra2-types 0.0.3

Shared types definitions for Red Alert 2
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
97

#![deny(missing_debug_implementations, missing_copy_implementations)]
#![warn(missing_docs, rustdoc::missing_crate_level_docs)]
#![doc = include_str!("../readme.md")]
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/208321371")]
#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/208321371")]

//! RA2 MIX file format library
//!
//! This library provides functionality for reading and writing Red Alert 2 MIX files.
//! It supports both encrypted and unencrypted MIX files, and can extract files from MIX archives.

mod errors;
mod games;

pub use crate::games::CncGame;
#[cfg(feature = "image")]
pub use image::{DynamicImage, Rgba, RgbaImage};
#[cfg(feature = "apng")]
pub use apng;
use std::{
    error::Error,
    fmt::{Display, Formatter},
};

/// Result type for RA2 MIX file operations
pub type Result<T> = std::result::Result<T, Ra2Error>;

/// Error type for RA2 MIX file operations
#[derive(Debug)]
pub enum Ra2Error {
    /// IO error
    IoError(std::io::Error),

    /// Crypto error
    CryptoError {
        /// The error message
        message: String,
    },
    /// Invalid file format
    InvalidFormat {
        /// The error message
        message: String,
    },
    /// Encode error
    EncodeError {
        /// The error format
        format: String,
        /// The error message
        message: String,
    },
    /// Decode error
    DecodeError {
        /// The error format
        format: String,
        /// The error message
        message: String,
    },
    /// Missing file
    FileNotFound(String),
    /// Out of boundary
    OutOfBoundary {
        /// Max limit
        limit: usize,
        /// The error message
        message: String,
    },
}

impl Error for Ra2Error {}

impl Display for Ra2Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Ra2Error::IoError(e) => {
                write!(f, "IO error: {}", e)
            }
            Ra2Error::CryptoError { message: e } => {
                write!(f, "Crypto error:: {}", e)
            }
            Ra2Error::InvalidFormat { message: e } => {
                write!(f, "Invalid file format: {}", e)
            }
            Ra2Error::FileNotFound(e) => {
                write!(f, "File not found: {}", e)
            }
            Ra2Error::DecodeError { format, message } => {
                write!(f, "Decode error: {}: {}", format, message)
            }
            Ra2Error::EncodeError { format, message } => {
                write!(f, "Encode error: {}: {}", format, message)
            }
            Ra2Error::OutOfBoundary { limit, message } => {
                write!(f, "Out of boundary {}: {}", limit, message)
            }
        }
    }
}