hdf5-pure 0.21.1

Pure-Rust HDF5 library: read, write, and edit files in place (WASM-compatible, 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

# Documentation site for hdf5-pure, built with Material for MkDocs.
#
# Tooling note: Material for MkDocs entered maintenance mode in Nov 2025; its
# successor, Zensical (https://zensical.org), is from the same team and reads a
# Material-compatible config. This site is deliberately built on the mature,
# feature-complete Material engine today; when Zensical reaches a stable release
# and feature parity, this config is the documented migration starting point.
#
# Local preview:   python -m venv .venv && . .venv/bin/activate
#                  pip install -r requirements-docs.txt && mkdocs serve
# Build (strict):  mkdocs build --strict

site_name: hdf5-pure
site_url: https://stephenberry.github.io/hdf5-pure/
site_description: >-
  Pure-Rust HDF5 reader, writer, and in-place editor. No C dependencies, no
  build scripts, WASM-compatible.
site_author: Stephen Berry
copyright: Copyright © 2026 Stephen Berry — MIT licensed

repo_url: https://github.com/stephenberry/hdf5-pure
repo_name: stephenberry/hdf5-pure
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.svg
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/stephenberry/hdf5-pure
      name: hdf5-pure on GitHub
    - icon: fontawesome/brands/rust
      link: https://crates.io/crates/hdf5-pure
      name: hdf5-pure on crates.io
    - icon: material/book-open-page-variant
      link: https://docs.rs/hdf5-pure
      name: API documentation on docs.rs

extra_css:
  - stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: On this page
  # PyMdown Extensions
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: [".", "docs"]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Guide:
      - Writing Files: guide/writing.md
      - Reading Files: guide/reading.md
      - Generic Element I/O: guide/generic-io.md
      - Groups & Attributes: guide/groups-attributes.md
      - Compression & Filters: guide/compression.md
      - Compound & Complex Types: guide/compound-types.md
      - N-dimensional Arrays: guide/ndarray.md
      - Variable-Length Strings: guide/vlen-strings.md
      - Editing in Place: guide/editing.md
      - Reclaiming Space (repack): guide/repack.md
      - File-Space Strategy: guide/file-space.md
      - Streaming Large Files: guide/streaming.md
      - SWMR: guide/swmr.md
  - Interoperability:
      - MATLAB v7.3 (.mat): interop/matlab.md
      - Portability — WASM, no_std, C library: interop/portability.md
  - Reference:
      - Data Types: reference/data-types.md
      - Cargo Features: reference/features.md
      - Limitations: reference/limitations.md
      - Changelog: reference/changelog.md
      - API Reference (docs.rs): https://docs.rs/hdf5-pure
  - About:
      - Architecture: about/architecture.md