Struct chd::ChdFile

pub struct ChdFile<F: Read + Seek> { /* private fields */ }

A CHD (MAME Compressed Hunks of Data) file.

Implementations

impl<F: Read + Seek> ChdFile<F>

pub fn open(file: F, parent: Option<Box<ChdFile<F>>>) -> Result<ChdFile<F>>

Open a CHD file from a Read + Seek stream. Optionally provide a parent of the same stream type.

The CHD header and hunk map are read and validated immediately.

pub fn header(&self) -> &ChdHeader

Returns a reference to the CHD header for this CHD file.

pub fn metadata(&mut self) -> Option<ChdMetadataRefIter<'_, F>>

Returns an iterator over the metadata entries for this CHD file.

The contents of each metadata entry are lazily read.

pub fn map(&self) -> &ChdMap

Returns the hunk map of this CHD File.

pub fn hunk(&mut self, hunk_num: u32) -> Result<ChdHunk<'_, F>>

Returns a reference to the given hunk in this CHD file.

If the requested hunk is larger than the number of hunks in the CHD file, returns ChdError::HunkOutofRange.

pub fn into_inner(self) -> F

Consumes the ChdFile and returns the underlying reader.