Struct hidefix::idx::Index

pub struct Index<'a> { /* fields omitted */ }

Implementations

impl Index<'_>

pub fn index<P>(path: P) -> Result<Index<'static>, Error> where
    P: AsRef<Path>, 

Open an existing HDF5 file and index all variables.

pub fn index_file<P>(
    hf: &File,
    path: Option<P>
) -> Result<Index<'static>, Error> where
    P: Into<PathBuf>, 

Index an open HDF5 file.

#[must_use]pub fn dataset(&self, s: &str) -> Option<&DatasetD<'_>>

pub fn datasets(&self) -> &HashMap<String, DatasetD<'_>>

#[must_use]pub fn path(&self) -> Option<&Path>

pub fn reader(&self, ds: &str) -> Result<Box<dyn Reader>, Error>

Create a cached reader for dataset.

This is a convenience method to use a standard std::fs::File with a cached reader, you are free to create use anything else with std::io::Read and std::io::Seek.

This method assumes the HDF5 file has the same location as at the time of indexing.

pub fn streamer(&self, ds: &str) -> Result<Box<dyn Streamer>, Error>

Create a streaming reader for dataset.

This is a convenience method to use a standard std::fs::File with a stream reader, you are free to create use anything else with std::io::Read and std::io::Seek.

This method assumes the HDF5 file has the same location as at the time of indexing.

Trait Implementations

impl<'a> Debug for Index<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Index<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> Serialize for Index<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ File> for Index<'_>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(f: &File) -> Result<Index<'static>, Error>

Performs the conversion.

impl TryFrom<&'_ Path> for Index<'_>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: &Path) -> Result<Index<'static>, Error>

Performs the conversion.