Enum Reference 

pub enum Reference {
    Null,
    Object {
        address: u64,
        file: Option<String>,
        path: Option<String>,
    },
    Region {
        address: u64,
        file: Option<String>,
        path: Option<String>,
        selection: Selection,
    },
    Attr {
        address: u64,
        file: Option<String>,
        path: Option<String>,
        name: String,
    },
}

One reference element, decoded and resolved against the file it came from.

path is the target’s absolute path when the file’s link structure names it, and None when nothing in the traversed structure points at that address — a reference into an untraversed part of the file, or a stale one left by a deletion. The address is reported either way.

Variants

Null

An element naming no object: the undefined address libhdf5 writes for an unset object reference, or a zeroed region-reference heap id.

Object

A whole object — H5R_OBJECT1 or H5R_OBJECT2.

Fields

address: u64

Object header address of the target.

file: Option<String>

The file the target lives in; see Reference::file.

path: Option<String>

Absolute path of the target.

Region

A dataset plus a selection over it — H5R_DATASET_REGION1 or H5R_DATASET_REGION2.

Fields

address: u64

Object header address of the target dataset.

file: Option<String>

The file the target dataset lives in; see Reference::file.

path: Option<String>

Absolute path of the target dataset.

selection: Selection

The selection the reference carries.

Attr

H5R_ATTR: one attribute of an object, by name. Only the 1.12 encodings can express it.

Fields

address: u64

Object header address of the object the attribute belongs to.

file: Option<String>

The file that object lives in; see Reference::file.

path: Option<String>

Absolute path of that object.

name: String

Name of the attribute.

Implementations

impl Reference

pub fn file(&self) -> Option<&str>

The file the target lives in, for a reference that names another file — H5Rget_file_name on an un-opened external reference. None means the file holding the reference, which is every reference libhdf5 can write without the H5R_IS_EXTERNAL flag.

The name is the one the target file was open under when the reference was written, recorded verbatim, and path is a path inside that file.

pub fn path(&self) -> Option<&str>

The target’s absolute path, when the file names it.

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

The target’s object header address, or None for a null reference.

pub fn attribute_name(&self) -> Option<&str>

The attribute an attribute reference names; None for the other kinds.

pub fn selection(&self) -> Option<&Selection>

The selection a region reference carries; None for the other kinds.

pub fn bounds(&self) -> Option<(Vec<u64>, Vec<u64>)>

The inclusive bounding box of a region reference’s selection — H5Sget_select_bounds on the dereferenced region.

pub fn is_null(&self) -> bool

Whether this element names no object.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reference