Struct Superblock 

pub struct Superblock {

    pub version: u8,
    pub offset_size: u8,
    pub length_size: u8,
    pub group_leaf_node_k: u16,
    pub group_internal_node_k: u16,
    pub indexed_storage_k: u16,
    pub consistency_flags: u32,
    pub base_address: u64,
    pub free_space_address: u64,
    pub eof_address: u64,
    pub driver_info_address: u64,
    pub root_symbol_table_entry: Option<SymbolTableEntry>,
    pub root_object_header_address: Option<u64>,
    pub extension_address: Option<u64>,
}

Parsed HDF5 superblock.

Fields

version: u8

Superblock version (0, 1, 2, or 3).

offset_size: u8

Size of offsets (addresses) in bytes: 2, 4, or 8.

length_size: u8

Size of lengths in bytes: 2, 4, or 8.

group_leaf_node_k: u16

Group leaf node K (v0/v1 only).

group_internal_node_k: u16

Group internal node K (v0/v1 only).

indexed_storage_k: u16

Indexed storage internal node K (v1 only).

consistency_flags: u32

File consistency flags.

base_address: u64

Base address for offsets (usually 0).

free_space_address: u64

Address of the file free-space info (undefined = not present).

eof_address: u64

End-of-file address.

driver_info_address: u64

Driver information block address (v0/v1 only).

root_symbol_table_entry: Option<SymbolTableEntry>

Root group symbol table entry (v0/v1).

root_object_header_address: Option<u64>

Root group object header address (v2/v3).

extension_address: Option<u64>

Superblock extension address (v2/v3).

Implementations

impl Superblock

pub fn parse(cursor: &mut Cursor<'_>) -> Result<Self>

Parse the superblock from a cursor positioned at byte 0 (or where the magic starts).

The cursor should be positioned at the start of the file. The method will search for the magic bytes at position 0, 512, 1024, 2048, etc.

pub fn root_object_header_address(&self) -> Result<u64>

Get the root group’s object header address.

pub fn root_btree_address(&self) -> Option<u64>

For v0/v1 superblocks, get the B-tree address from the root symbol table entry’s scratch-pad (used for root group navigation).

pub fn root_local_heap_address(&self) -> Option<u64>

For v0/v1 superblocks, get the local heap address from the root symbol table entry’s scratch-pad.

Trait Implementations

impl Clone for Superblock

fn clone(&self) -> Superblock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Superblock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.