Struct TarballReader

pub struct TarballReader<'c> {
    archive: Archive<CompressionDecoder<'c>>,
}

A generic tarball reader that can be used to read both compressed tarballs .tar.* and uncompressed tar archives .tar.

Can be created from a Path or PathBuf, which will automatically detect the optional compression algorithm based on the file extension.

Note

The lifetime 'c is for CompressionDecoder of the underlying Archive.

Fields

archive: Archive<CompressionDecoder<'c>>

Implementations

impl<'c> TarballReader<'c>

pub fn new(decoder: CompressionDecoder<'c>) -> Self

Creates a new TarballReader that reads from a CompressionDecoder.

pub fn entries<'a>(&'a mut self) -> Result<TarballEntries<'a, 'c>, Error>

Returns an iterator over the entries in the tarball.

Errors

Returns an error if Archive::entries fails.

pub fn read_entry<'a, P: AsRef<Path>>( &'a mut self, path: P, ) -> Result<Option<TarballEntry<'a, 'c>>, Error>

Reads a specific TarballEntry by its path.

Returns None if the entry does not exist.

Errors

Returns an error if Self::entries or reading an entry fails.

Trait Implementations

impl Debug for TarballReader<'_>

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

Formats the value using the given formatter.

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

fn try_from(path: &Path) -> Result<Self, Self::Error>

Creates a new TarballReader from a Path.

Errors

Returns an error if

• the file at path cannot be opened for reading,
• the file extension is neither a .tar nor an extension of a supported compression algorithm,
• a CompressionDecoder cannot be created from the file and DecompressionSettings.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<PathBuf> for TarballReader<'_>

fn try_from(path: PathBuf) -> Result<Self, Self::Error>

Creates a TarballReader from PathBuf.

Delegates to the TryFrom implementation for Path.

Errors

Returns an error if the TryFrom implementation for Path fails.

type Error = Error

The type returned in the event of a conversion error.