Struct tar::Archive

pub struct Archive<R: ?Sized + Read> { /* private fields */ }

A top-level representation of an archive file.

This archive can have an entry added to it and it can be iterated over.

Implementations

impl<R: Read> Archive<R>

pub fn new(obj: R) -> Archive<R>

Create a new archive with the underlying object as the reader.

pub fn into_inner(self) -> R

Unwrap this archive, returning the underlying object.

pub fn entries(&mut self) -> Result<Entries<'_, R>>

Construct an iterator over the entries in this archive.

Note that care must be taken to consider each entry within an archive in sequence. If entries are processed out of sequence (from what the iterator returns), then the contents read for each entry may be corrupted.

pub fn unpack<P: AsRef<Path>>(&mut self, dst: P) -> Result<()>

Unpacks the contents tarball into the specified dst.

This function will iterate over the entire contents of this tarball, extracting each file in turn to the location specified by the entry’s path name.

This operation is relatively sensitive in that it will not write files outside of the path specified by dst. Files in the archive which have a ‘..’ in their path are skipped during the unpacking process.

Examples

use std::fs::File;
use tar::Archive;

let mut ar = Archive::new(File::open("foo.tar").unwrap());
ar.unpack("foo").unwrap();

pub fn set_mask(&mut self, mask: u32)

Set the mask of the permission bits when unpacking this entry.

The mask will be inverted when applying against a mode, similar to how umask works on Unix. In logical notation it looks like:

new_mode = old_mode & (~mask)

The mask is 0 by default and is currently only implemented on Unix.

pub fn set_unpack_xattrs(&mut self, unpack_xattrs: bool)

Indicate whether extended file attributes (xattrs on Unix) are preserved when unpacking this archive.

This flag is disabled by default and is currently only implemented on Unix using xattr support. This may eventually be implemented for Windows, however, if other archive implementations are found which do this as well.

pub fn set_preserve_permissions(&mut self, preserve: bool)

Indicate whether extended permissions (like suid on Unix) are preserved when unpacking this entry.

This flag is disabled by default and is currently only implemented on Unix.

pub fn set_preserve_ownerships(&mut self, preserve: bool)

Indicate whether numeric ownership ids (like uid and gid on Unix) are preserved when unpacking this entry.

This flag is disabled by default and is currently only implemented on Unix.

pub fn set_overwrite(&mut self, overwrite: bool)

Indicate whether files and symlinks should be overwritten on extraction.

pub fn set_preserve_mtime(&mut self, preserve: bool)

Indicate whether access time information is preserved when unpacking this entry.

This flag is enabled by default.

pub fn set_ignore_zeros(&mut self, ignore_zeros: bool)

Ignore zeroed headers, which would otherwise indicate to the archive that it has no more entries.

This can be used in case multiple tar archives have been concatenated together.

impl<R: Seek + Read> Archive<R>

pub fn entries_with_seek(&mut self) -> Result<Entries<'_, R>>

Construct an iterator over the entries in this archive for a seekable reader. Seek will be used to efficiently skip over file contents.

Note that care must be taken to consider each entry within an archive in sequence. If entries are processed out of sequence (from what the iterator returns), then the contents read for each entry may be corrupted.