mrc 0.2.5

MRC-2014 file format reader/writer for cryo-EM — SIMD-accelerated, mmap-enabled
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

//! Compression detection helpers.
//!
//! Provides [`CompressionType`] and [`detect_compression`] used internally by
//! [`Reader::open`](crate::Reader::open) to auto-detect gzip/bzip2.

use crate::Error;
use std::path::Path;

/// Detected compression format of an MRC file.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CompressionType {
    /// Uncompressed MRC file.
    Plain,
    /// Gzip-compressed MRC file.
    #[cfg(feature = "gzip")]
    Gzip,
    /// Bzip2-compressed MRC file.
    #[cfg(feature = "bzip2")]
    Bzip2,
}

/// Peek at the first bytes of a file to determine its compression format.
///
/// | Magic bytes | Format |
/// |-------------|--------|
/// | `\x1f\x8b` | Gzip |
/// | `BZ` | Bzip2 |
/// | anything else | Plain |
///
/// This performs a single small read from the beginning of the file.
pub fn detect_compression<P: AsRef<Path>>(path: P) -> Result<CompressionType, Error> {
    use std::fs::File;
    use std::io::Read;

    let mut file = File::open(path)?;
    let mut magic = [0u8; 2];
    let n = file.read(&mut magic)?;
    if n < 2 {
        return Ok(CompressionType::Plain);
    }

    #[cfg(feature = "gzip")]
    if magic == [0x1f, 0x8b] {
        return Ok(CompressionType::Gzip);
    }

    #[cfg(feature = "bzip2")]
    if magic == [b'B', b'Z'] {
        return Ok(CompressionType::Bzip2);
    }

    Ok(CompressionType::Plain)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_detect_compression_plain() {
        let tmp = tempfile::NamedTempFile::new().unwrap();
        std::fs::write(tmp.path(), b"MAP ").unwrap();
        assert_eq!(
            detect_compression(tmp.path()).unwrap(),
            CompressionType::Plain
        );
    }

    #[test]
    #[cfg(feature = "gzip")]
    fn test_detect_compression_gzip() {
        use std::io::Write;
        let tmp = tempfile::NamedTempFile::new().unwrap();
        let mut file = std::fs::File::create(tmp.path()).unwrap();
        file.write_all(&[0x1f, 0x8b, 0x08, 0x00]).unwrap();
        drop(file);
        assert_eq!(
            detect_compression(tmp.path()).unwrap(),
            CompressionType::Gzip
        );
    }

    #[test]
    #[cfg(feature = "bzip2")]
    fn test_detect_compression_bzip2() {
        use std::io::Write;
        let tmp = tempfile::NamedTempFile::new().unwrap();
        let mut file = std::fs::File::create(tmp.path()).unwrap();
        file.write_all(b"BZh").unwrap();
        drop(file);
        assert_eq!(
            detect_compression(tmp.path()).unwrap(),
            CompressionType::Bzip2
        );
    }
}