Trait hdf5_rs::Container [−] [src]

pub trait Container: Location {
    fn len(&self) -> u64 { ... }
    fn is_empty(&self) -> bool { ... }
    fn create_group<S: Into<String>>(&self, name: S) -> Result<Group> { ... }
    fn group<S: Into<String>>(&self, name: S) -> Result<Group> { ... }
    fn link_soft<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()> { ... }
    fn link_hard<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()> { ... }
    fn relink<S1: Into<String>, S2: Into<String>>(&self, name: S1, path: S2) -> Result<()> { ... }
    fn unlink<S: Into<String>>(&self, name: S) -> Result<()> { ... }
    fn new_dataset<T: ToDatatype>(&self) -> DatasetBuilder<T> { ... }
    fn dataset<S: Into<String>>(&self, name: S) -> Result<Dataset> { ... }
}

A trait for HDF5 objects that can contain other objects (file, group).

Provided Methods

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.

Implementors