Enum DataLayoutMessage 

pub enum DataLayoutMessage {
    Contiguous {
        address: u64,
        size: u64,
    },
    Compact {
        data: Vec<u8>,
    },
    ChunkedV3 {
        chunk_dims: Vec<u64>,
        b_tree_address: u64,
    },
    ChunkedV4 {
        version: u8,
        flags: u8,
        chunk_dims: Vec<u64>,
        index_type: ChunkIndexType,
        earray_params: Option<EarrayParams>,
        farray_params: Option<FixedArrayParams>,
        single_chunk_filter: Option<SingleChunkFilter>,
        index_address: u64,
    },
}

Data layout message payload.

Variants

Contiguous

Contiguous storage — raw data in a single block.

Fields

address: u64

Address of raw data. UNDEF_ADDR if not yet allocated.

size: u64

Size of raw data in bytes.

Compact

Compact storage — raw data stored within the object header.

Fields

data: Vec<u8>

The raw data bytes.

ChunkedV3

Version 3 chunked storage, indexed by a version-1 B-tree.

This is what libhdf5 / h5py writes for a chunked dataset created with the default libver bounds.

Fields

chunk_dims: Vec<u64>

Chunk dimension sizes, including the trailing element-size dimension (so the chunk rank is chunk_dims.len() - 1).

b_tree_address: u64

Address of the version-1 B-tree that indexes the chunks.

ChunkedV4

Version 4 chunked storage. Version 5 shares this exact wire format — only the version byte differs — so both decode into this variant.

Fields

version: u8

Message version byte: 4 or 5. Version 5 (libhdf5 2.0, H5O_LAYOUT_VERSION_5) declares that the chunk index encodes filtered-chunk sizes in a fixed sizeof_size-byte field instead of the width derived from the chunk byte count, so a filter may expand a chunk without overflowing the field. Readers older than libhdf5 2.0 reject version 5.

flags: u8

chunk_dims: Vec<u64>

Chunk dimension sizes.

index_type: ChunkIndexType

Type of chunk index structure.

earray_params: Option<EarrayParams>

Extensible array parameters (present when index_type == ExtensibleArray).

farray_params: Option<FixedArrayParams>

Fixed array parameters (present when index_type == FixedArray).

single_chunk_filter: Option<SingleChunkFilter>

Filtered single-chunk parameters (present when index_type == SingleChunk and the layout’s filtered flag 0x02 is set).

index_address: u64

Address of the chunk index structure.

Implementations

impl DataLayoutMessage

pub fn contiguous_unallocated(size: u64) -> Self

Contiguous layout with no data allocated yet.

pub fn contiguous(address: u64, size: u64) -> Self

Contiguous layout pointing to allocated data.

pub fn compact(data: Vec<u8>) -> Self

Compact layout with inline data.

pub fn chunked_v3_btree_v1(chunk_dims: Vec<u64>, b_tree_address: u64) -> Self

Version 3 chunked layout indexed by a version-1 B-tree.

chunk_dims must include the trailing element-size dimension.

pub fn chunked_v4_earray( version: u8, chunk_dims: Vec<u64>, earray_params: EarrayParams, index_address: u64, ) -> Self

Version 4 chunked layout with extensible array index.

chunk_dims should include the trailing element-size dimension. For example, for a 2D dataset with chunk=(1,4) and element_size=8, pass chunk_dims = [1, 4, 8].

pub fn chunked_v4_farray( version: u8, chunk_dims: Vec<u64>, farray_params: FixedArrayParams, index_address: u64, ) -> Self

Version 4 chunked layout with fixed array index.

chunk_dims should include the trailing element-size dimension.

pub fn chunked_v4_btree_v2( version: u8, chunk_dims: Vec<u64>, index_address: u64, ) -> Self

Version 4 chunked layout with B-tree v2 index.

chunk_dims should include the trailing element-size dimension.

pub fn chunked_v4_single(chunk_dims: Vec<u64>, index_address: u64) -> Self

Version 4 chunked layout with single-chunk index.

chunk_dims should include the trailing element-size dimension.

pub fn encode(&self, ctx: &FormatContext) -> Vec<u8>

pub fn decode(buf: &[u8], ctx: &FormatContext) -> FormatResult<(Self, usize)>

Trait Implementations

impl Clone for DataLayoutMessage

fn clone(&self) -> DataLayoutMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataLayoutMessage

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

Formats the value using the given formatter.

impl PartialEq for DataLayoutMessage

fn eq(&self, other: &DataLayoutMessage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DataLayoutMessage