Struct hdf5_rs::Dataset

pub struct Dataset {
    // some fields omitted
}

Represents the HDF5 dataset object.

Methods

impl Dataset

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

Returns the shape of the dataset.

fn ndim(&self) -> usize

Returns the number of dimensions in the dataset.

fn size(&self) -> usize

Returns the total number of elements in the dataset.

fn is_scalar(&self) -> bool

Returns whether this dataset is a scalar.

fn is_resizable(&self) -> bool

Returns whether this dataset is resizable along some axis.

fn is_chunked(&self) -> bool

Returns whether this dataset has a chunked layout.

fn is_type<T: ToDatatype>(&self) -> bool

Returns whether this dataset's type is equivalent to the given type.

fn chunks(&self) -> Option<Vec<Ix>>

Returns the chunk shape if the dataset is chunked.

fn filters(&self) -> Filters

Returns the filters used to create the dataset.

fn tracks_times(&self) -> bool

Returns true if object modification time is tracked by the dataset.

fn storage_size(&self) -> u64

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

fn offset(&self) -> Option<u64>

Returns the absolute byte offset of the dataset in the file if such offset is defined (which is not the case for datasets that are chunked, compact or not allocated yet).

fn fill_value<T: ToDatatype>(&self) -> Result<Option<T>>

Returns default fill value for the dataset if such value is set. Note that conversion to the requested type is done by HDF5 which may result in loss of precision for floating-point values if the datatype differs from the datatype of of the dataset.

fn datatype(&self) -> Result<Datatype>

Returns a new Datatype object associated with this dataset.

Trait Implementations

impl Object for Dataset

fn refcount(&self) -> u32

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

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).

fn id_type(&self) -> H5I_type_t

Returns type of the object.

impl Location for Dataset

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).

fn filename(&self) -> String

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

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

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

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

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

fn set_comment<S: Into<String>>(&self, comment: S) -> Result<()>

Set or the commment attached to the named object.

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

Clear the commment attached to the named object.