Struct TarArchive 

pub struct TarArchive { /* private fields */ }

An owning, validated Tar archive.

Unlike TarArchiveRef, this type takes ownership of the archive bytes. TarArchive::new validates the supplied data before constructing the archive.

This is only available with the alloc feature of this crate.

Implementations

impl TarArchive

pub fn new(data: Box<[u8]>) -> Result<Self, CorruptDataError>

Creates an owning wrapper around validated Tar archive bytes.

The supplied data must have a valid block layout, contain at least the minimum number of blocks, and end with two zero blocks. Each archive header must have a valid checksum and type flag, and every payload size must lead to a header or the terminating zero blocks within the archive.

Validation checks the archive structure required for safe iteration. It does not guarantee that every supported entry can be consumed without further format-specific limitations; see ArchiveEntryIterator.

Returns an error, if the sanity checks report problems.

Errors

Returns CorruptDataError if validation fails.

pub fn entries(&self) -> ArchiveEntryIterator<'_>

Iterates over the regular files in the Tar archive.

See ArchiveEntryIterator for format support and limitations.

pub fn headers(&self) -> ArchiveHeaderIterator<'_>

Iterates over the headers in the Tar archive.

PAX extended headers are returned as normal PosixHeader values, while their payload blocks are skipped before the next iteration.

Trait Implementations

impl Clone for TarArchive

fn clone(&self) -> TarArchive

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TarArchive

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

Formats the value using the given formatter.

impl Eq for TarArchive

impl From<Box<[u8]>> for TarArchive

Available on crate feature alloc only.

fn from(data: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<TarArchive> for Box<[u8]>

Available on crate feature alloc only.

fn from(ar: TarArchive) -> Self

Converts to this type from the input type.

impl PartialEq for TarArchive

fn eq(&self, other: &TarArchive) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TarArchive