steam-vdf-parser 0.1.1

Zero-copy parser for Steam's VDF (Valve Data Format) 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
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

//! Utilities for reading little-endian values from byte slices.

/// Reads a little-endian u32 from a byte slice.
///
/// Returns `None` if the slice doesn't have enough bytes.
///
/// # Examples
/// ```
/// use steam_vdf_parser::binary::read_u32_le;
///
/// let data = [0x01, 0x02, 0x03, 0x04];
/// assert_eq!(read_u32_le(&data), Some(0x04030201));
/// assert_eq!(read_u32_le(&[0x01, 0x02]), None);
/// ```
#[inline]
pub fn read_u32_le(input: &[u8]) -> Option<u32> {
    input.get(..4).and_then(|bytes| {
        let arr: [u8; 4] = bytes.try_into().ok()?;
        Some(u32::from_le_bytes(arr))
    })
}

/// Reads a little-endian u64 from a byte slice.
///
/// Returns `None` if the slice doesn't have enough bytes.
///
/// # Examples
/// ```
/// use steam_vdf_parser::binary::read_u64_le;
///
/// let data = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08];
/// assert_eq!(read_u64_le(&data), Some(0x0807060504030201));
/// assert_eq!(read_u64_le(&[0x01, 0x02]), None);
/// ```
#[inline]
pub fn read_u64_le(input: &[u8]) -> Option<u64> {
    input.get(..8).and_then(|bytes| {
        let arr: [u8; 8] = bytes.try_into().ok()?;
        Some(u64::from_le_bytes(arr))
    })
}

/// Reads a little-endian u32 from a byte slice at a specific offset.
///
/// Returns `None` if the slice doesn't have enough bytes from the offset.
///
/// # Examples
/// ```
/// use steam_vdf_parser::binary::read_u32_le_at;
///
/// let data = [0xFF, 0xFF, 0x01, 0x02, 0x03, 0x04];
/// assert_eq!(read_u32_le_at(&data, 2), Some(0x04030201));
/// assert_eq!(read_u32_le_at(&data, 4), None);
/// ```
#[inline]
pub fn read_u32_le_at(input: &[u8], offset: usize) -> Option<u32> {
    input.get(offset..offset + 4).and_then(|bytes| {
        let arr: [u8; 4] = bytes.try_into().ok()?;
        Some(u32::from_le_bytes(arr))
    })
}

/// Reads a little-endian u64 from a byte slice at a specific offset.
///
/// Returns `None` if the slice doesn't have enough bytes from the offset.
///
/// # Examples
/// ```
/// use steam_vdf_parser::binary::read_u64_le_at;
///
/// let data = [0xFF, 0xFF, 0xFF, 0xFF, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08];
/// assert_eq!(read_u64_le_at(&data, 4), Some(0x0807060504030201));
/// assert_eq!(read_u64_le_at(&data, 8), None);
/// ```
#[inline]
pub fn read_u64_le_at(input: &[u8], offset: usize) -> Option<u64> {
    input.get(offset..offset + 8).and_then(|bytes| {
        let arr: [u8; 8] = bytes.try_into().ok()?;
        Some(u64::from_le_bytes(arr))
    })
}

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

    #[test]
    fn test_read_u32_le() {
        let data = [0x01, 0x02, 0x03, 0x04];
        assert_eq!(read_u32_le(&data), Some(0x04030201));
    }

    #[test]
    fn test_read_u32_le_short() {
        assert_eq!(read_u32_le(&[0x01, 0x02]), None);
        assert_eq!(read_u32_le(&[]), None);
    }

    #[test]
    fn test_read_u64_le() {
        let data = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08];
        assert_eq!(read_u64_le(&data), Some(0x0807060504030201));
    }

    #[test]
    fn test_read_u64_le_short() {
        assert_eq!(read_u64_le(&[0x01, 0x02, 0x03, 0x04]), None);
        assert_eq!(read_u64_le(&[]), None);
    }

    #[test]
    fn test_read_u32_le_at() {
        let data = [0xFF, 0xFF, 0x01, 0x02, 0x03, 0x04];
        assert_eq!(read_u32_le_at(&data, 0), Some(0x0201FFFF));
        assert_eq!(read_u32_le_at(&data, 2), Some(0x04030201));
    }

    #[test]
    fn test_read_u32_le_at_out_of_bounds() {
        let data = [0x01, 0x02, 0x03, 0x04];
        assert_eq!(read_u32_le_at(&data, 1), None);
        assert_eq!(read_u32_le_at(&data, 4), None);
    }

    #[test]
    fn test_read_u64_le_at() {
        let data = [0xFF; 12];
        assert_eq!(read_u64_le_at(&data, 0), Some(0xFFFFFFFFFFFFFFFF));
        assert_eq!(read_u64_le_at(&data, 4), Some(0xFFFFFFFFFFFFFFFF));
    }

    #[test]
    fn test_read_u64_le_at_out_of_bounds() {
        let data = [0x01; 8];
        assert_eq!(read_u64_le_at(&data, 1), None);
        assert_eq!(read_u64_le_at(&data, 8), None);
    }
}