Struct DotthzFile

pub struct DotthzFile { /* private fields */ }

A structure representing a .thz file according to the dotThz standard

Implementations

impl DotthzFile

pub fn create(path: &PathBuf) -> Result<Self, Box<dyn Error>>

Create an empty DotthzFile to the specified path, truncates if exists.

pub fn open(filename: &PathBuf) -> Result<Self, Box<dyn Error>>

Loads a DotthzFile from the specified path as read-only, file must exist.

pub fn open_rw<P: AsRef<Path>>(filename: P) -> Result<Self, Box<dyn Error>>

Opens a file as read/write, file must exist.

pub fn create_excl<P: AsRef<Path>>(filename: P) -> Result<Self, Box<dyn Error>>

Creates a file, fails if exists.

pub fn append<P: AsRef<Path>>(filename: P) -> Result<Self, Box<dyn Error>>

Opens a file as read/write if exists, creates otherwise.

pub fn open_as<P: AsRef<Path>>( filename: P, mode: OpenMode, ) -> Result<Self, Box<dyn Error>>

Opens a file in a given mode.

pub fn size(&self) -> u64

Returns the file size in bytes (or 0 if the file handle is invalid).

pub fn free_space(&self) -> u64

Returns the free space in the file in bytes (or 0 if the file handle is invalid).

pub fn is_read_only(&self) -> bool

Returns true if the file was opened in a read-only mode.

pub fn userblock(&self) -> u64

Returns the userblock size in bytes (or 0 if the file handle is invalid).

pub fn flush(&self) -> Result<(), Box<dyn Error>>

Flushes the file to the storage medium.

pub fn close(self) -> Result<(), Box<dyn Error>>

Closes the file and invalidates all open handles for contained objects.

pub fn access_plist(&self) -> Result<FileAccess>

Returns a copy of the file access property list.

pub fn fapl(&self) -> Result<FileAccess>

A short alias for access_plist().

pub fn create_plist(&self) -> Result<FileCreate>

Returns a copy of the file creation property list.

pub fn fcpl(&self) -> Result<FileCreate>

A short alias for create_plist().

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

get group names

pub fn get_group(&self, group_name: &str) -> Result<Group>

get group by name

pub fn get_groups(&self) -> Result<Vec<Group>>

get groups

pub fn get_dataset_names(&self, group_name: &str) -> Result<Vec<String>>

get dataset names for a given group name

pub fn get_dataset( &self, group_name: &str, dataset_name: &str, ) -> Result<Dataset>

get dataset for a given group name by dataset name

pub fn get_datasets(&self, group_name: &str) -> Result<Vec<Dataset>>

get datasets for a given group name

pub fn set_meta_data( &self, group: &mut Group, meta_data: &DotthzMetaData, ) -> Result<(), Box<dyn Error>>

set meta-data for a given group

pub fn get_meta_data(&self, group_name: &str) -> Result<DotthzMetaData>

extract meta-data for a given group by group name

pub fn add_group( &mut self, group_name: &str, metadata: &DotthzMetaData, ) -> Result<Group, Box<dyn Error>>

Add a group with meta-data and group name to the DotthzFile.

pub fn add_dataset<T, D>( &mut self, group_name: &str, dataset_name: &str, dataset: ArrayView<'_, T, D>, ) -> Result<(), Box<dyn Error>>

where T: H5Type + Debug, D: Dimension,

Add a dataset to a given group by group name and dataset name.