Struct hdf5_rs::Group

pub struct Group {
    // some fields omitted
}

Represents the HDF5 group object.

Trait Implementations

impl Debug for Group

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

Formats the value using the given formatter.

impl Display for Group

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

Formats the value using the given formatter.

impl Object for Group

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 Group

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.

impl Container for Group

fn len(&self) -> u64

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

fn is_empty(&self) -> bool

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

fn create_group<S: Into<String>>(&self, name: S) -> Result<Group>

Create a new group in a file or group.

fn group<S: Into<String>>(&self, name: S) -> Result<Group>

Opens an existing group in a file or group.

fn link_soft<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()>

Creates a soft link. Note: name and path are relative to the current object.

fn link_hard<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()>

Creates a hard link. Note: name and path are relative to the current object.

fn relink<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()>

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

fn unlink<S: Into<String>>(&self, name: S) -> Result<()>

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

fn new_dataset<T: ToDatatype>(&self) -> DatasetBuilder<T>

Instantiates a new dataset builder.

fn dataset<S: Into<String>>(&self, name: S) -> Result<Dataset>

Opens an existing dataset in the file or group.