bumpy 0.0.5

A library for reading and manipulating bitmap (.bmp) 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
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

use std::fs::File;
use std::io::{self, Read, Write};

// A struct representing the BMP file header.
#[repr(C)]
pub struct BmpHeader {
    pub signature: [u8; 2],
    pub file_size: [u8; 4],
    pub reserved: [u8; 4],
    pub data_offset: [u8; 4]
}

impl BmpHeader {

    /// Creates a new `BmpHeader` struct.
    ///     
    /// # Arguments
    /// 
    /// * `width` - The width of the image in pixels.
    /// * `height` - The height of the image in pixels.
    /// 
    /// # Returns
    /// 
    /// Returns a `BmpHeader` struct.
    pub fn new(width: u32, height: u32) -> Self {
        let file_size = u32::to_le_bytes((width * height * 3) + 54);

        BmpHeader {
            signature: [66, 77],
            file_size,
            reserved: [0; 4],
            data_offset: u32::to_le_bytes(54)
        }
    }

    /// Builds a `BmpHeader` struct from a file.
    /// 
    /// # Arguments
    /// 
    /// * `file` - A mutable reference to a `File` object.
    /// 
    /// # Returns
    /// 
    /// Returns a `Result` containing the `BmpHeader` if successful, or an `io::Error` if an error occurred.
    pub fn build_from_file(file: &mut File) -> io::Result<Self> {
        let mut header = BmpHeader {
            signature: [0; 2],
            file_size: [0; 4],
            reserved: [0; 4],
            data_offset: [0; 4]
        };

        // Read the BMP file header
        file.read_exact(&mut header.signature)?;
        file.read_exact(&mut header.file_size)?;
        file.read_exact(&mut header.reserved)?;
        file.read_exact(&mut header.data_offset)?;

        Ok(header)
    }

    /// Writes the `BmpHeader` to a file.
    /// 
    /// # Arguments
    /// 
    /// * `file` - A mutable reference to a `File` object.
    /// 
    /// # Returns
    /// 
    /// Returns a `Result` containing `()` if successful, or an `io::Error` if an error occurred.
    pub fn write_to_file(&self, file: &mut File) -> io::Result<()> {
        file.write(&self.signature)?;
        file.write(&self.file_size)?;
        file.write(&self.reserved)?;
        file.write(&self.data_offset)?;

        println!("Wrote BMP header to file");

        Ok(())
    }
}

impl Clone for BmpHeader {
    fn clone(&self) -> Self {
        BmpHeader {
            signature: self.signature,
            file_size: self.file_size,
            reserved: self.reserved,
            data_offset: self.data_offset
        }
    }
}