Struct GlobalHeapCollection 

pub struct GlobalHeapCollection {
    pub objects: Vec<GlobalHeapObject>,
}

A global heap collection, containing a set of heap objects.

Fields

objects: Vec<GlobalHeapObject>

The heap objects in this collection (index > 0).

Implementations

impl GlobalHeapCollection

pub fn new() -> Self

Create an empty global heap collection.

pub fn add_object(&mut self, data: Vec<u8>) -> u16

Add a data blob to the collection. Returns the 1-based object index.

pub fn get_object(&self, index: u16) -> Option<&[u8]>

Retrieve the data for an object by its 1-based index.

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

Encode the collection into a byte vector.

The encoded blob includes the GCOL header and all heap objects, followed by a free-space marker (index=0 object). The total size is padded to at least 4096 bytes (H5HG_MINALLOC) for compatibility with the HDF5 C library.

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

Decode a global heap collection from a byte buffer.

Returns the collection and the number of bytes consumed.

Trait Implementations

impl Clone for GlobalHeapCollection

fn clone(&self) -> GlobalHeapCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalHeapCollection

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

Formats the value using the given formatter.

impl Default for GlobalHeapCollection

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for GlobalHeapCollection

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GlobalHeapCollection

impl StructuralPartialEq for GlobalHeapCollection