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

👎 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 Location

fn clone(&self) -> Location

Returns a copy of the value.

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.