Enum Layout 

#[non_exhaustive]
pub enum Layout {
    Compact {
        size: u64,
    },
    Contiguous {
        address: Option<u64>,
        size: u64,
    },
    Chunked {
        chunk_shape: Vec<u64>,
        index: ChunkIndex,
    },
    Virtual,
}

How a dataset’s raw data is arranged on disk.

The curated analogue of HDF5’s layout class (H5Pget_layout), enriched with the per-class facts needed to locate or size the data without decoding it. Obtain it with Dataset::layout.

Use it to choose a reading strategy: a Contiguous dataset is a single seek-and-read, while a Chunked dataset is read (and, for an appendable index, grown) one chunk at a time — enumerate its chunks with Dataset::chunks.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Compact

Stored inline in the dataset’s object header, as used for tiny datasets. The bytes are already resident once the header is read, so there is no separate file region to seek to; size is the inline byte count.

Fields

size: u64

The number of raw bytes stored inline.

Contiguous

Stored as one contiguous run of bytes.

Fields

address: Option<u64>

Absolute file offset of the first byte, or None when storage has not been allocated yet (a fixed-shape dataset that was never written). In that case size is the extent that would be written.

size: u64

The length of the run in bytes.

Chunked

Stored as a grid of independently located (and optionally filtered) chunks. Filtered datasets are always chunked.

Fields

chunk_shape: Vec<u64>

The chunk edge lengths, one per dataset dimension, in the same order as shape. This is the value returned by chunk_shape; the on-disk element-size dimension is stripped.

index: ChunkIndex

The index that maps chunk coordinates to file addresses, which governs append eligibility (see ChunkIndex).

Virtual

A virtual dataset whose data is mapped from other datasets. Only the classification is exposed; the source mappings are not decoded.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Display for Layout

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

Formats the value using the given formatter.

impl Eq for Layout

impl PartialEq for Layout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Layout