Struct hdf5::Reader

pub struct Reader<'a> { /* fields omitted */ }

Implementations

impl<'a> Reader<'a>

pub fn new(obj: &'a Container) -> Self

Creates a reader for a dataset/attribute.

Any conversions (including hard/soft) are allowed by default.

pub fn conversion(self, conv: Conversion) -> Self

Set maximum allowed conversion level.

pub fn no_convert(self) -> Self

Disallow all conversions.

pub fn read_slice<T, S, D>(&self, selection: S) -> Result<Array<T, D>> where
    T: H5Type,
    S: TryInto<Selection>,
    Error: From<S::Error>,
    D: Dimension, 

Reads a slice of an n-dimensional array. If the dimensionality D has a fixed number of dimensions, it must match the dimensionality of the slice, after singleton dimensions are dropped. Use the multi-dimensional slice macro s![] from ndarray to conveniently create a multidimensional slice.

pub fn read<T: H5Type, D: Dimension>(&self) -> Result<Array<T, D>>

Reads a dataset/attribute into an n-dimensional array.

If the array has a fixed number of dimensions, it must match the dimensionality of the dataset/attribute.

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

Reads a dataset/attribute into a vector in memory order.

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

Reads a dataset/attribute into a 1-dimensional array.

The dataset/attribute must be 1-dimensional.

pub fn read_slice_1d<T, S>(&self, selection: S) -> Result<Array1<T>> where
    T: H5Type,
    S: TryInto<Selection>,
    Error: From<S::Error>, 

Reads the given slice of the dataset into a 1-dimensional array. The slice must yield a 1-dimensional result.

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

Reads a dataset/attribute into a 2-dimensional array.

The dataset/attribute must be 2-dimensional.

pub fn read_slice_2d<T, S>(&self, selection: S) -> Result<Array2<T>> where
    T: H5Type,
    S: TryInto<Selection>,
    Error: From<S::Error>, 

Reads the given slice of the dataset into a 2-dimensional array. The slice must yield a 2-dimensional result.

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

Reads a dataset/attribute into an array with dynamic number of dimensions.

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

Reads a scalar dataset/attribute.

Trait Implementations

impl<'a> Debug for Reader<'a>

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

Formats the value using the given formatter.