Struct Archive

pub struct Archive<R: Read + Unpin> { /* 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 + Unpin> 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) -> Result<R, Self>

Unwrap this archive, returning the underlying object.

pub fn entries(self) -> Result<Entries<R>>

Construct an stream 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 stream returns), then the contents read for each entry may be corrupted.

pub fn entries_raw(self) -> Result<RawEntries<R>>

Construct an stream over the raw 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 stream returns), then the contents read for each entry may be corrupted.

pub async fn unpack<P: AsRef<Path>>(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 async_std::fs::File;
use async_tar::Archive;

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

Trait Implementations

impl<R: Read + Unpin> Clone for Archive<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Read + Unpin> Debug for Archive<R>

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

Formats the value using the given formatter.

impl<R: Read + Unpin> AsyncRead for Archive<R>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, into: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.