hdf5-pure-rust 0.3.0

Pure Rust implementation of the HDF5 file 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
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

use crate::error::{Error, Result};
use crate::format::messages::dataspace::DataspaceMessage;
use crate::format::messages::datatype::DatatypeMessage;

/// Parsed Attribute message (type 0x000C).
#[derive(Debug, Clone)]
pub struct AttributeMessage {
    pub version: u8,
    pub name: String,
    pub datatype: DatatypeMessage,
    pub dataspace: DataspaceMessage,
    /// Raw attribute data bytes.
    pub data: Vec<u8>,
}

impl AttributeMessage {
    pub fn decode(raw: &[u8]) -> Result<Self> {
        Self::decode_impl(raw)
    }

    fn decode_impl(raw: &[u8]) -> Result<Self> {
        if raw.len() < 6 {
            return Err(Error::InvalidFormat("attribute message too short".into()));
        }

        let version = raw[0];
        match version {
            1 => Self::decode_v1(raw),
            2 => Self::decode_v2(raw),
            3 => Self::decode_v3(raw),
            _ => Err(Error::InvalidFormat(format!(
                "attribute message version {version}"
            ))),
        }
    }

    fn decode_v1(raw: &[u8]) -> Result<Self> {
        // v1: version(1) + reserved(1) + name_size(2) + datatype_size(2) + dataspace_size(2)
        ensure_available(raw, 0, 8, "attribute v1 header")?;
        let name_size = u16::from_le_bytes([raw[2], raw[3]]) as usize;
        let dt_size = u16::from_le_bytes([raw[4], raw[5]]) as usize;
        let ds_size = u16::from_le_bytes([raw[6], raw[7]]) as usize;
        if name_size == 0 {
            return Err(Error::InvalidFormat(
                "attribute message name length is zero".into(),
            ));
        }
        let mut pos = 8;

        // Name (null-padded to 8-byte boundary)
        ensure_available(raw, pos, name_size, "attribute v1 name")?;
        let name_end = raw[pos..pos + name_size]
            .iter()
            .position(|&b| b == 0)
            .unwrap_or(name_size);
        let name = String::from_utf8_lossy(&raw[pos..pos + name_end]).to_string();
        let name_padded = (name_size + 7) & !7;
        ensure_available(raw, pos, name_padded, "attribute v1 padded name")?;
        pos += name_padded;

        // Datatype (padded to 8-byte boundary)
        ensure_available(raw, pos, dt_size, "attribute v1 datatype")?;
        let datatype = DatatypeMessage::decode(&raw[pos..pos + dt_size])?;
        let dt_padded = (dt_size + 7) & !7;
        ensure_available(raw, pos, dt_padded, "attribute v1 padded datatype")?;
        pos += dt_padded;

        // Dataspace (padded to 8-byte boundary)
        ensure_available(raw, pos, ds_size, "attribute v1 dataspace")?;
        let dataspace = DataspaceMessage::decode(&raw[pos..pos + ds_size])?;
        let ds_padded = (ds_size + 7) & !7;
        ensure_available(raw, pos, ds_padded, "attribute v1 padded dataspace")?;
        pos += ds_padded;

        // Data
        let data = raw[pos..].to_vec();

        Ok(Self {
            version: 1,
            name,
            datatype,
            dataspace,
            data,
        })
    }

    fn decode_v2(raw: &[u8]) -> Result<Self> {
        // v2: version(1) + flags(1) + name_size(2) + datatype_size(2) + dataspace_size(2)
        ensure_available(raw, 0, 8, "attribute v2 header")?;
        let name_size = u16::from_le_bytes([raw[2], raw[3]]) as usize;
        let dt_size = u16::from_le_bytes([raw[4], raw[5]]) as usize;
        let ds_size = u16::from_le_bytes([raw[6], raw[7]]) as usize;
        if name_size == 0 {
            return Err(Error::InvalidFormat(
                "attribute message name length is zero".into(),
            ));
        }
        let mut pos = 8;

        // Name (NOT padded in v2)
        ensure_available(raw, pos, name_size, "attribute v2 name")?;
        let name_end = raw[pos..pos + name_size]
            .iter()
            .position(|&b| b == 0)
            .unwrap_or(name_size);
        let name = String::from_utf8_lossy(&raw[pos..pos + name_end]).to_string();
        pos += name_size;

        // Datatype (NOT padded in v2)
        ensure_available(raw, pos, dt_size, "attribute v2 datatype")?;
        let datatype = DatatypeMessage::decode(&raw[pos..pos + dt_size])?;
        pos += dt_size;

        // Dataspace (NOT padded in v2)
        ensure_available(raw, pos, ds_size, "attribute v2 dataspace")?;
        let dataspace = DataspaceMessage::decode(&raw[pos..pos + ds_size])?;
        pos += ds_size;

        let data = raw[pos..].to_vec();

        Ok(Self {
            version: 2,
            name,
            datatype,
            dataspace,
            data,
        })
    }

    fn decode_v3(raw: &[u8]) -> Result<Self> {
        // v3: version(1) + flags(1) + name_size(2) + datatype_size(2) + dataspace_size(2) + encoding(1)
        ensure_available(raw, 0, 9, "attribute v3 header")?;
        let _flags = raw[1];
        let name_size = u16::from_le_bytes([raw[2], raw[3]]) as usize;
        let dt_size = u16::from_le_bytes([raw[4], raw[5]]) as usize;
        let ds_size = u16::from_le_bytes([raw[6], raw[7]]) as usize;
        let _encoding = raw[8]; // character encoding: 0=ASCII, 1=UTF-8
        if name_size == 0 {
            return Err(Error::InvalidFormat(
                "attribute message name length is zero".into(),
            ));
        }
        let mut pos = 9;

        ensure_available(raw, pos, name_size, "attribute v3 name")?;
        let name_end = raw[pos..pos + name_size]
            .iter()
            .position(|&b| b == 0)
            .unwrap_or(name_size);
        let name = String::from_utf8_lossy(&raw[pos..pos + name_end]).to_string();
        pos += name_size;

        ensure_available(raw, pos, dt_size, "attribute v3 datatype")?;
        let datatype = DatatypeMessage::decode(&raw[pos..pos + dt_size])?;
        pos += dt_size;

        ensure_available(raw, pos, ds_size, "attribute v3 dataspace")?;
        let dataspace = DataspaceMessage::decode(&raw[pos..pos + ds_size])?;
        pos += ds_size;

        let data = raw[pos..].to_vec();

        Ok(Self {
            version: 3,
            name,
            datatype,
            dataspace,
            data,
        })
    }

    /// Get total number of elements.
    pub fn num_elements(&self) -> Result<u64> {
        if self.dataspace.dims.is_empty() {
            Ok(1) // scalar
        } else {
            self.dataspace.dims.iter().try_fold(1u64, |acc, &dim| {
                acc.checked_mul(dim)
                    .ok_or_else(|| Error::InvalidFormat("attribute element count overflow".into()))
            })
        }
    }

    /// Get total data size in bytes.
    pub fn data_size(&self) -> Result<usize> {
        let elements = usize::try_from(self.num_elements()?)
            .map_err(|_| Error::InvalidFormat("attribute element count overflow".into()))?;
        elements
            .checked_mul(self.datatype.size as usize)
            .ok_or_else(|| Error::InvalidFormat("attribute data size overflow".into()))
    }
}

fn ensure_available(raw: &[u8], pos: usize, len: usize, context: &str) -> Result<()> {
    let end = pos
        .checked_add(len)
        .ok_or_else(|| Error::InvalidFormat(format!("{context} length overflow")))?;
    if end > raw.len() {
        return Err(Error::InvalidFormat(format!("{context} is truncated")));
    }
    Ok(())
}