Skip to main content

Hdf5File

Struct Hdf5File 

Source
pub struct Hdf5File { /* private fields */ }
Expand description

An opened HDF5 file.

This is the main entry point for reading HDF5 files. The file data is memory-mapped for efficient access.

Implementations§

Source§

impl Hdf5File

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open an HDF5 file with default options.

Source

pub fn open_with_options( path: impl AsRef<Path>, options: OpenOptions, ) -> Result<Self>

Open an HDF5 file with custom options.

Source

pub fn from_bytes(data: &[u8]) -> Result<Self>

Open an HDF5 file from an in-memory byte slice.

The data is copied into an owned buffer.

Source

pub fn from_bytes_with_options( data: &[u8], options: OpenOptions, ) -> Result<Self>

Open an HDF5 file from an in-memory byte slice with custom options.

The data is copied into an owned buffer.

Source

pub fn from_vec(data: Vec<u8>) -> Result<Self>

Open an HDF5 file from an owned byte vector without copying.

Source

pub fn from_vec_with_options( data: Vec<u8>, options: OpenOptions, ) -> Result<Self>

Open an HDF5 file from an owned byte vector with custom options.

Source

pub fn from_mmap_with_options(mmap: Mmap, options: OpenOptions) -> Result<Self>

Open an HDF5 file from an existing memory map with custom options.

This avoids remapping when the caller already owns a read-only mapping.

Source

pub fn superblock(&self) -> &Superblock

Get the parsed superblock.

Source

pub fn get_or_parse_header(&self, addr: u64) -> Result<Arc<ObjectHeader>>

Look up or parse an object header at the given address.

Uses the internal cache to avoid re-parsing the same header.

Source

pub fn root_group(&self) -> Result<Group<'_>>

Get the root group of the file.

Source

pub fn dataset(&self, path: &str) -> Result<Dataset<'_>>

Convenience: get a dataset at a path like “/group1/dataset”.

Source

pub fn group(&self, path: &str) -> Result<Group<'_>>

Convenience: get a group at a path like “/group1/subgroup”.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.