Struct hdf5::File

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

HDF5 file object.

Implementations

impl File

pub fn open<P: AsRef<Path>>(filename: P) -> Result<Self>

Opens a file as read-only, file must exist.

pub fn open_rw<P: AsRef<Path>>(filename: P) -> Result<Self>

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

pub fn create<P: AsRef<Path>>(filename: P) -> Result<Self>

Creates a file, truncates if exists.

pub fn create_excl<P: AsRef<Path>>(filename: P) -> Result<Self>

Creates a file, fails if exists.

pub fn append<P: AsRef<Path>>(filename: P) -> Result<Self>

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

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

Opens a file in a given mode.

pub fn with_options() -> FileBuilder

Opens a file with custom file-access and file-creation options.

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

Flushes the file to the storage medium.

pub fn close(self) -> Result<()>

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

Methods from Deref<Target = Group>

pub fn len(&self) -> u64

Returns the number of objects in the container (or 0 if the container is invalid).

pub fn is_empty(&self) -> bool

Returns true if the container has no linked objects (or if the container is invalid).

pub fn create_group(&self, name: &str) -> Result<Self>

Create a new group in a file or group.

pub fn group(&self, name: &str) -> Result<Self>

Opens an existing group in a file or group.

pub fn link_soft(&self, target: &str, link_name: &str) -> Result<()>

Creates a soft link.

A soft link does not require the linked object to exist. Note: target and link_name are relative to the current object.

pub fn link_hard(&self, target: &str, link_name: &str) -> Result<()>

Creates a hard link. Note: target and link_name are relative to the current object.

pub fn link_external(
    &self,
    target_file_name: &str,
    target: &str,
    link_name: &str
) -> Result<()>

Creates an external link.

Note: link_name is relative to the current object, target is relative to the root of the source file, target_file_name is the path to the external file.

For a detailed explanation on how target_file_name is resolved, see https://portal.hdfgroup.org/display/HDF5/H5L_CREATE_EXTERNAL

pub fn relink(&self, name: &str, path: &str) -> Result<()>

Relinks an object. Note: name and path are relative to the current object.

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

Removes a link to an object from this file or group.

pub fn link_exists(&self, name: &str) -> bool

Check if a link with a given name exists in this file or group.

pub fn new_dataset<T: H5Type>(&self) -> DatasetBuilderEmpty

Instantiates a new typed dataset builder.

pub fn new_dataset_builder(&self) -> DatasetBuilder

Instantiates a new dataset builder.

pub fn dataset(&self, name: &str) -> Result<Dataset>

Opens an existing dataset in the file or group.

pub fn iter_visit<F, G>(
    &self,
    iteration_order: IterationOrder,
    traversal_order: TraversalOrder,
    val: G,
    op: F
) -> Result<G> where
    F: Fn(&Self, &str, LinkInfo, &mut G) -> bool, 

Visits all objects in the group

pub fn iter_visit_default<F, G>(&self, val: G, op: F) -> Result<G> where
    F: Fn(&Self, &str, LinkInfo, &mut G) -> bool, 

Visits all objects in the group using default iteration/traversal order.

pub fn groups(&self) -> Result<Vec<Self>>

Returns all groups in the group, non-recursively

pub fn datasets(&self) -> Result<Vec<Dataset>>

Returns all datasets in the group, non-recursively

pub fn named_datatypes(&self) -> Result<Vec<Datatype>>

Returns all named types in the group, non-recursively

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

Returns the names of all objects in the group, non-recursively.

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 File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Deref for File

type Target = Group

The resulting type after dereferencing.

fn deref(&self) -> &Group

Dereferences the value.