Struct hdf5::Location

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

Named location (file, group, dataset, named datatype).

Implementations

impl 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.

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.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl Deref for Location

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.