Struct hdf5::Container

#[repr(transparent)]
pub struct Container(_);

An object which can be read or written to.

Implementations

impl Container

pub fn as_reader(&self) -> Reader<'_>

Creates a reader wrapper for this dataset/attribute, allowing to set custom type conversion options when reading.

pub fn as_writer(&self) -> Writer<'_>

Creates a writer wrapper for this dataset/attribute, allowing to set custom type conversion options when writing.

pub fn dtype(&self) -> Result<Datatype>

Returns the datatype of the dataset/attribute.

pub fn space(&self) -> Result<Dataspace>

Returns the dataspace of the dataset/attribute.

pub fn shape(&self) -> Vec<Ix>

Returns the shape of the dataset/attribute.

pub fn ndim(&self) -> usize

Returns the number of dimensions in the dataset/attribute.

pub fn size(&self) -> usize

Returns the total number of elements in the dataset/attribute.

pub fn is_scalar(&self) -> bool

Returns whether this dataset/attribute is a scalar.

pub fn storage_size(&self) -> u64

Returns the amount of file space required for the dataset/attribute. Note that this only accounts for the space which has actually been allocated (it can be equal to zero).

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_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_scalar<T: H5Type>(&self) -> Result<T>

Reads a scalar dataset/attribute.

pub fn write<'b, A, T, D>(&self, arr: A) -> Result<()> where
    A: Into<ArrayView<'b, T, D>>,
    T: H5Type,
    D: Dimension, 

Writes an n-dimensional array view into a dataset/attribute.

The shape of the view must match the shape of the dataset/attribute exactly. The input argument must be convertible to an array view (this includes slices).

pub fn write_raw<'b, A, T>(&self, arr: A) -> Result<()> where
    A: Into<ArrayView1<'b, T>>,
    T: H5Type, 

Writes a 1-dimensional array view into a dataset/attribute in memory order.

The number of elements in the view must match the number of elements in the destination dataset/attribute. The input argument must be convertible to a 1-dimensional array view (this includes slices).

pub fn write_slice<'b, A, T, S, D>(&self, arr: A, selection: S) -> Result<()> where
    A: Into<ArrayView<'b, T, D>>,
    T: H5Type,
    S: TryInto<Selection>,
    Error: From<S::Error>,
    D: Dimension, 

Writes all data from the array arr into the given slice of the target dataset. The shape of arr must match the shape the set of elements included in the slice. If the array has a fixed number of dimensions, it must match the dimensionality of dataset. Use the multi-dimensional slice macro s![] from ndarray to conveniently create a multidimensional slice.

pub fn write_scalar<T: H5Type>(&self, val: &T) -> Result<()>

Writes a scalar dataset/attribute.

Methods from Deref<Target = Location>

pub fn name(&self) -> String

Returns the name of the object within the file, or empty string if the object doesn’t have a name (e.g., an anonymous dataset).

pub fn filename(&self) -> String

Returns the name of the file containing the named object (or the file itself).

pub fn file(&self) -> Result<File>

Returns a handle to the file containing the named object (or the file itself).

pub fn comment(&self) -> Option<String>

Returns the commment attached to the named object, if any.

pub fn set_comment(&self, comment: &str) -> Result<()>

👎 Deprecated:

attributes are preferred to comments

Set or the commment attached to the named object.

pub fn clear_comment(&self) -> Result<()>

👎 Deprecated:

attributes are preferred to comments

Clear the commment attached to the named object.

pub fn new_attr<T: H5Type>(&self) -> AttributeBuilderEmpty

pub fn new_attr_builder(&self) -> AttributeBuilder

pub fn attr(&self, name: &str) -> Result<Attribute>

pub fn attr_names(&self) -> Result<Vec<String>>

pub fn loc_info(&self) -> Result<LocationInfo>

pub fn loc_type(&self) -> Result<LocationType>

pub fn loc_info_by_name(&self, name: &str) -> Result<LocationInfo>

pub fn loc_type_by_name(&self, name: &str) -> Result<LocationType>

pub fn open_by_token(&self, token: LocationToken) -> Result<Self>

Methods from Deref<Target = Object>

pub fn id(&self) -> hid_t

pub fn refcount(&self) -> u32

Returns reference count if the handle is valid and 0 otherwise.

pub fn is_valid(&self) -> bool

Returns true if the object has a valid unlocked identifier (false for pre-defined locked identifiers like property list classes).

pub fn id_type(&self) -> H5I_type_t

Returns type of the object.

pub fn as_file(&self) -> Result<File>

Downcast the object into $tp if possible.

pub fn as_group(&self) -> Result<Group>

Downcast the object into $tp if possible.

pub fn as_dataset(&self) -> Result<Dataset>

Downcast the object into $tp if possible.

pub fn as_location(&self) -> Result<Location>

Downcast the object into $tp if possible.

pub fn as_attr(&self) -> Result<Attribute>

Downcast the object into $tp if possible.

pub fn as_container(&self) -> Result<Container>

Downcast the object into $tp if possible.

pub fn as_datatype(&self) -> Result<Datatype>

Downcast the object into $tp if possible.

pub fn as_dataspace(&self) -> Result<Dataspace>

Downcast the object into $tp if possible.

pub fn as_plist(&self) -> Result<PropertyList>

Downcast the object into $tp if possible.

Trait Implementations

impl Clone for Container

fn clone(&self) -> Container

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Container

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

Formats the value using the given formatter.

impl Deref for Container

type Target = Location

The resulting type after dereferencing.

fn deref(&self) -> &Location

Dereferences the value.