hdf5-reader 0.3.0

Pure-Rust, read-only HDF5 file decoder with no C dependencies
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

use std::fmt;

/// Errors produced by the HDF5 reader.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    #[error("invalid HDF5 magic bytes")]
    InvalidMagic,

    #[error("unsupported superblock version {0}")]
    UnsupportedSuperblockVersion(u8),

    #[error("unsupported object header version {0}")]
    UnsupportedObjectHeaderVersion(u8),

    #[error("unsupported B-tree version {0}")]
    UnsupportedBTreeVersion(u8),

    #[error("unsupported symbol table node version {0}")]
    UnsupportedSymbolTableNodeVersion(u8),

    #[error("unsupported local heap version {0}")]
    UnsupportedLocalHeapVersion(u8),

    #[error("unsupported global heap version {0}")]
    UnsupportedGlobalHeapVersion(u8),

    #[error("unsupported fractal heap version {0}")]
    UnsupportedFractalHeapVersion(u8),

    #[error("unsupported dataspace version {0}")]
    UnsupportedDataspaceVersion(u8),

    #[error("unsupported datatype class {0}")]
    UnsupportedDatatypeClass(u8),

    #[error("unsupported layout class {0}")]
    UnsupportedLayoutClass(u8),

    #[error("unsupported layout version {0}")]
    UnsupportedLayoutVersion(u8),

    #[error("unsupported filter pipeline version {0}")]
    UnsupportedFilterPipelineVersion(u8),

    #[error("unsupported fill value version {0}")]
    UnsupportedFillValueVersion(u8),

    #[error("unsupported link message version {0}")]
    UnsupportedLinkVersion(u8),

    #[error("unsupported link type {0}")]
    UnsupportedLinkType(u8),

    #[error("unsupported attribute message version {0}")]
    UnsupportedAttributeVersion(u8),

    #[error("unsupported B-tree v2 record type {0}")]
    UnsupportedBTreeV2RecordType(u8),

    #[error("unsupported chunk indexing type {0}")]
    UnsupportedChunkIndexType(u8),

    #[error("unsupported size of offsets: {0}")]
    UnsupportedOffsetSize(u8),

    #[error("unsupported size of lengths: {0}")]
    UnsupportedLengthSize(u8),

    #[error("invalid B-tree signature")]
    InvalidBTreeSignature,

    #[error("invalid symbol table node signature")]
    InvalidSymbolTableNodeSignature,

    #[error("invalid local heap signature")]
    InvalidLocalHeapSignature,

    #[error("invalid global heap signature")]
    InvalidGlobalHeapSignature,

    #[error("invalid fractal heap signature")]
    InvalidFractalHeapSignature,

    #[error("invalid object header signature")]
    InvalidObjectHeaderSignature,

    #[error("invalid B-tree v2 signature: {context}")]
    InvalidBTreeV2Signature { context: &'static str },

    #[error("invalid fixed array signature: {context}")]
    InvalidFixedArraySignature { context: &'static str },

    #[error("invalid extensible array signature: {context}")]
    InvalidExtensibleArraySignature { context: &'static str },

    #[error("checksum mismatch: expected {expected:#010x}, got {actual:#010x}")]
    ChecksumMismatch { expected: u32, actual: u32 },

    #[error("unexpected end of data at offset {offset} (need {needed} bytes, have {available})")]
    UnexpectedEof {
        offset: u64,
        needed: u64,
        available: u64,
    },

    #[error("offset {0:#x} is out of bounds")]
    OffsetOutOfBounds(u64),

    #[error("group not found: {0}")]
    GroupNotFound(String),

    #[error("dataset not found: {0}")]
    DatasetNotFound(String),

    #[error("attribute not found: {0}")]
    AttributeNotFound(String),

    #[error("type mismatch: expected {expected}, got {actual}")]
    TypeMismatch { expected: String, actual: String },

    #[error("unsupported filter: {0}")]
    UnsupportedFilter(String),

    #[error("decompression error: {0}")]
    DecompressionError(String),

    #[error("filter pipeline error: {0}")]
    FilterError(String),

    #[error("invalid data: {0}")]
    InvalidData(String),

    #[error("slice out of bounds: dimension {dim}, index {index}, size {size}")]
    SliceOutOfBounds { dim: usize, index: u64, size: u64 },

    #[error("undefined address (0xFFFFFFFFFFFFFFFF)")]
    UndefinedAddress,

    #[error("{0}")]
    Other(String),

    #[error("{path}: {source}")]
    Context { path: String, source: Box<Error> },
}

impl Error {
    /// Wrap this error with an object path for additional context.
    pub fn with_context(self, path: impl Into<String>) -> Self {
        Error::Context {
            path: path.into(),
            source: Box::new(self),
        }
    }
}

pub type Result<T> = std::result::Result<T, Error>;

/// Byte order for numeric data.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ByteOrder {
    LittleEndian,
    BigEndian,
}

impl fmt::Display for ByteOrder {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ByteOrder::LittleEndian => write!(f, "little-endian"),
            ByteOrder::BigEndian => write!(f, "big-endian"),
        }
    }
}