Struct H5Attribute 

pub struct H5Attribute { /* private fields */ }

A handle to an HDF5 attribute.

After creating an attribute via AttrBuilder::create, use write_scalar or write_string to set its value.

In read mode, use read_string to read string attributes.

Implementations

impl H5Attribute

pub fn name(&self) -> &str

Return the attribute name.

pub fn write_scalar(&self, value: &VarLenUnicode) -> Result<()>

Write a scalar value to the attribute.

For VarLenUnicode, this writes a fixed-length string attribute whose size is determined by the string value.

pub fn write_string(&self, value: &str) -> Result<()>

Write a string value to the attribute (convenience method).

pub fn write_numeric<T: H5Type>(&self, value: &T) -> Result<()>

Write a numeric scalar attribute.

let file = H5File::create("num_attr.h5").unwrap();
let ds = file.new_dataset::<f32>().shape(&[10]).create("data").unwrap();
ds.write_raw(&[0.0f32; 10]).unwrap();
let attr = ds.new_attr::<f64>().shape(()).create("scale").unwrap();
attr.write_numeric(&3.14f64).unwrap();

pub fn read_numeric<T: H5Type>(&self) -> Result<T>

Read a numeric scalar attribute.

let file = H5File::open("num_attr.h5").unwrap();
let ds = file.dataset("data").unwrap();
let attr = ds.attr("scale").unwrap();
let val: f64 = attr.read_numeric().unwrap();

pub fn read_string(&self) -> Result<String>

Read the attribute value as a string.

Works for fixed-length string attributes (as written by this library) and returns the string value with any trailing null bytes stripped.

pub fn read_raw(&self) -> Result<Vec<u8>>

Read the raw attribute data bytes.