ncmdump 0.8.0

Some copyright protection file dump.
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use std::io::Read;

use crate::error::Result;

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum FileType {
    /// The standard ncm file.
    #[cfg(feature = "ncmdump")]
    Ncm,
    /// The standard qmc file.
    #[cfg(feature = "qmcdump")]
    Qmc,
    /// The other file type.
    Other,
}

impl FileType {
    /// Return the file type of the reader.
    ///
    /// > Notice: This function can't resolve the `Ncmdump` or `QmcDump`
    ///
    /// # Example
    ///
    /// ```
    /// # use std::fs::File;
    /// # use ncmdump::utils::FileType;
    /// #
    /// let mut file = File::open("res/test.ncm").unwrap();
    /// let file_type = FileType::parse(&mut file).unwrap();
    /// ```
    pub fn parse<R>(reader: &mut R) -> Result<Self>
    where
        R: Read,
    {
        let mut head = [0; 8];
        if reader.read(&mut head)? != 8 {
            return Ok(FileType::Other);
        }

        let file_type = match head[..] {
            #[cfg(feature = "ncmdump")]
            [0x43, 0x54, 0x45, 0x4E, 0x46, 0x44, 0x41, 0x4D] => FileType::Ncm,
            #[cfg(feature = "qmcdump")]
            [0xA5, 0x06, 0xB7, 0x89, _, _, _, _] => FileType::Qmc,
            #[cfg(feature = "qmcdump")]
            [0x8A, 0x0E, 0xE5, _, _, _, _, _] => FileType::Qmc,
            _ => FileType::Other,
        };
        Ok(file_type)
    }
}

/// Return the file type of the reader.
///
/// > Notice: This function can't resolve the `Ncmdump` or `QmcDump`
///
/// # Example
///
/// ```
/// # use std::fs::File;
/// # use ncmdump::utils::get_file_type;
/// #
/// let mut file = File::open("res/test.ncm").unwrap();
/// let file_type = get_file_type(&mut file).unwrap();
/// ```
#[deprecated]
pub fn get_file_type<R>(reader: &mut R) -> Result<FileType>
where
    R: Read,
{
    FileType::parse(reader)
}

/// Check if the reader is ncm format.
///
/// > Notice: The function can't resolve the `Ncmdump` or `QmcDump`
///
/// # Example
///
/// ```
/// # use std::fs::File;
/// # use ncmdump::utils::is_ncm_file;
/// #
/// let mut file = File::open("res/test.ncm").unwrap();
/// let result = is_ncm_file(&mut file).unwrap();
/// ```
#[cfg(feature = "ncmdump")]
pub fn is_ncm_file<R>(reader: &mut R) -> Result<bool>
where
    R: Read,
{
    let file_type = FileType::parse(reader)?;
    Ok(file_type == FileType::Ncm)
}

/// Check if the reader is qmc format.
///
/// > Notice: The function can't resolve the `Ncmdump` or `QmcDump`
///
/// # Example
///
/// ```
/// # use std::fs::File;
/// # use ncmdump::utils::is_qmc_file;
/// #
/// let mut file = File::open("res/test.ncm").unwrap();
/// let result = is_qmc_file(&mut file).unwrap();
/// ```
#[cfg(feature = "qmcdump")]
pub fn is_qmc_file<R>(reader: &mut R) -> Result<bool>
where
    R: Read,
{
    let file_type = FileType::parse(reader)?;
    Ok(file_type == FileType::Qmc)
}

#[cfg(test)]
mod tests {
    use std::fs::File;
    use std::io::Error;

    use crate::utils::{is_ncm_file, FileType};

    #[cfg(feature = "ncmdump")]
    #[test]
    fn test_is_ncm_file_ok() -> Result<(), Error> {
        let mut file = File::open("res/test.ncm")?;
        let result = is_ncm_file(&mut file);
        assert!(result.is_ok());
        assert!(result.unwrap());
        Ok(())
    }

    #[cfg(feature = "ncmdump")]
    #[test]
    fn test_get_file_type_ok() -> Result<(), Error> {
        let mut file = File::open("res/test.ncm")?;
        let file_type = FileType::parse(&mut file);
        assert!(file_type.is_ok());
        assert_eq!(file_type.unwrap(), FileType::Ncm);
        Ok(())
    }
}