Struct hdf5::Group

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

Represents the HDF5 group object.

Implementations

impl 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, src: &str, dst: &str) -> Result<()>

Creates a soft link. Note: src and dst are relative to the current object.

pub fn link_hard(&self, src: &str, dst: &str) -> Result<()>

Creates a hard link. Note: src and dst are relative to the current object.

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) -> DatasetBuilder<T>

Instantiates a new dataset builder.

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

Opens an existing dataset in the file or group.

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

Returns names of all the members 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<()>

Set or the commment attached to the named object.

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

Clear the commment attached to the named object.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl Deref for Group

type Target = Location

The resulting type after dereferencing.

fn deref(&self) -> &Location

Dereferences the value.