[−][src]Struct hdf5::File
HDF5 file object.
Implementations
impl File
[src]
pub fn open<P: AsRef<Path>>(filename: P) -> Result<Self>
[src]
Opens a file as read-only, file must exist.
pub fn open_rw<P: AsRef<Path>>(filename: P) -> Result<Self>
[src]
Opens a file as read/write, file must exist.
pub fn create<P: AsRef<Path>>(filename: P) -> Result<Self>
[src]
Creates a file, truncates if exists.
pub fn create_excl<P: AsRef<Path>>(filename: P) -> Result<Self>
[src]
Creates a file, fails if exists.
pub fn append<P: AsRef<Path>>(filename: P) -> Result<Self>
[src]
Opens a file as read/write if exists, creates otherwise.
pub fn open_as<P: AsRef<Path>>(filename: P, mode: OpenMode) -> Result<Self>
[src]
Opens a file in a given mode.
pub fn with_options() -> FileBuilder
[src]
Opens a file with custom file-access and file-creation options.
pub fn size(&self) -> u64
[src]
Returns the file size in bytes (or 0 if the file handle is invalid).
pub fn free_space(&self) -> u64
[src]
Returns the free space in the file in bytes (or 0 if the file handle is invalid).
pub fn is_read_only(&self) -> bool
[src]
Returns true if the file was opened in a read-only mode.
pub fn userblock(&self) -> u64
[src]
Returns the userblock size in bytes (or 0 if the file handle is invalid).
pub fn flush(&self) -> Result<()>
[src]
Flushes the file to the storage medium.
pub fn close(self)
[src]
Closes the file and invalidates all open handles for contained objects.
pub fn access_plist(&self) -> Result<FileAccess>
[src]
Returns a copy of the file access property list.
pub fn fapl(&self) -> Result<FileAccess>
[src]
A short alias for access_plist()
.
pub fn create_plist(&self) -> Result<FileCreate>
[src]
Returns a copy of the file creation property list.
pub fn fcpl(&self) -> Result<FileCreate>
[src]
A short alias for create_plist()
.
Methods from Deref<Target = Group>
pub fn len(&self) -> u64
[src]
Returns the number of objects in the container (or 0 if the container is invalid).
pub fn is_empty(&self) -> bool
[src]
Returns true if the container has no linked objects (or if the container is invalid).
pub fn create_group(&self, name: &str) -> Result<Self>
[src]
Create a new group in a file or group.
pub fn group(&self, name: &str) -> Result<Self>
[src]
Opens an existing group in a file or group.
pub fn link_soft(&self, src: &str, dst: &str) -> Result<()>
[src]
Creates a soft link. Note: src
and dst
are relative to the current object.
pub fn link_hard(&self, src: &str, dst: &str) -> Result<()>
[src]
Creates a hard link. Note: src
and dst
are relative to the current object.
pub fn relink(&self, name: &str, path: &str) -> Result<()>
[src]
Relinks an object. Note: name
and path
are relative to the current object.
pub fn unlink(&self, name: &str) -> Result<()>
[src]
Removes a link to an object from this file or group.
pub fn link_exists(&self, name: &str) -> bool
[src]
Check if a link with a given name exists in this file or group.
pub fn new_dataset<T: H5Type>(&self) -> DatasetBuilder<T>
[src]
Instantiates a new dataset builder.
pub fn dataset(&self, name: &str) -> Result<Dataset>
[src]
Opens an existing dataset in the file or group.
pub fn member_names(&self) -> Result<Vec<String>>
[src]
Returns names of all the members in the group, non-recursively.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for File
impl Send for File
impl Sync for File
impl Unpin for File
impl !UnwindSafe for File
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,