snowbinary 0.4.0

A header based system for writing and reading binary files using its own format
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

use std::{convert::TryInto, fs::File, io::Read, mem};

use crate::error::SnowBinError;

#[inline]
pub fn error(result: std::io::Result<usize>) -> Result<usize, SnowBinError> {
    result.map_or(Err(SnowBinError::IOWriteError), Ok)
}

pub fn read_header(file: &mut File, header_len: u32) -> Result<String, SnowBinError> {
    let mut buffer = vec![32_u8; header_len as usize];
    error(file.by_ref().take(u64::from(header_len)).read(&mut buffer))?;

    String::from_utf8(buffer).map_err(|_| SnowBinError::MalformedHeader)
}

pub fn read_bytes(file: &mut File, length: u64) -> Result<Vec<u8>, SnowBinError> {
    #[allow(clippy::cast_possible_truncation)]
    let mut buffer = vec![0_u8; length as usize];
    error(file.by_ref().take(length).read(&mut buffer))?;

    Ok(buffer)
}

pub fn read_u8(file: &mut File) -> Result<u8, SnowBinError> {
    let mut buffer = [0_u8; 1];
    error(file.by_ref().take(1).read(&mut buffer))?;

    let (uint_bytes, _) = buffer.split_at(mem::size_of::<u8>());
    let uint = u8::from_le_bytes(
        uint_bytes
            .try_into()
            .map_err(|_| SnowBinError::MalformedUInt)?,
    );

    Ok(uint)
}

pub fn read_u16(file: &mut File) -> Result<u16, SnowBinError> {
    let mut buffer = [0_u8; 2];
    error(file.by_ref().take(2).read(&mut buffer))?;

    let (uint_bytes, _) = buffer.split_at(mem::size_of::<u16>());
    let uint = u16::from_le_bytes(
        uint_bytes
            .try_into()
            .map_err(|_| SnowBinError::MalformedUInt)?,
    );

    Ok(uint)
}

pub fn read_u32(file: &mut File) -> Result<u32, SnowBinError> {
    let mut buffer = [0_u8; 4];
    error(file.by_ref().take(4).read(&mut buffer))?;

    let (uint_bytes, _) = buffer.split_at(mem::size_of::<u32>());
    let uint = u32::from_le_bytes(
        uint_bytes
            .try_into()
            .map_err(|_| SnowBinError::MalformedUInt)?,
    );

    Ok(uint)
}

pub fn read_u64(file: &mut File) -> Result<u64, SnowBinError> {
    let mut buffer = [0_u8; 8];
    error(file.by_ref().take(8).read(&mut buffer))?;

    let (uint_bytes, _) = buffer.split_at(mem::size_of::<u64>());
    let uint = u64::from_le_bytes(
        uint_bytes
            .try_into()
            .map_err(|_| SnowBinError::MalformedUInt)?,
    );

    Ok(uint)
}