TarArchive

TarArchive class

This class represents a tar archive file. Use it to compose, extract, or update tar archives.

The TarArchive type exposes the following members:

Constructors

NameDescription
TarArchive()Initializes a new instance of the TarArchive class.
TarArchive(source_stream)Initializes a new instance of the Archive class and composes an entry list can be extracted from the archive.
TarArchive(path)Initializes a new instance of the TarArchive class and composes an entry list can be extracted from the archive.

Properties

NameDescription
entriesGets entries of TarEntry type constituting the archive.
file_entriesGets entries of IArchiveFileEntry type constituting the archive.
formatGets the archive format.

Methods

NameDescription
delete_entry(entry)Removes the first occurrence of a specific entry from the entry list.
delete_entry(entry_index)Removes the entry from the entry list by index.
save(output, format)
save(destination_file_name, format)
save_gzipped(output, format)
save_gzipped(path, format)
save_zstandard(output, format)
save_zstandard(path, format)
save_lzipped(output, format)
save_lzipped(path, format)
save_lzma_compressed(output, format)
save_lzma_compressed(path, format)
save_lz4_compressed(output, format)
save_lz4_compressed(path, format)
save_xz_compressed(output, format, settings)
save_xz_compressed(path, format, settings)
save_z_compressed(output, format)
save_z_compressed(path, format)
from_g_zip(source)Extracts supplied gzip archive and composes TarArchive from extracted data.
from_g_zip(path)Extracts supplied gzip archive and composes TarArchive from extracted data.
from_zstandard(source)Extracts supplied Zstandard archive and composes TarArchive from extracted data.
from_zstandard(path)Extracts supplied Zstandard archive and composes TarArchive from extracted data.
from_l_zip(source)Extracts supplied lzip archive and composes TarArchive from extracted data.
from_l_zip(path)Extracts supplied lzip archive and composes TarArchive from extracted data.
from_lzma(source)Extracts supplied LZMA archive and composes TarArchive from extracted data.
from_lzma(path)Extracts supplied LZMA archive and composes TarArchive from extracted data.
from_lz4(path)Extracts supplied LZ4 archive and composes TarArchive from extracted data.
from_lz4(source)Extracts supplied LZ4 archive and composes TarArchive from extracted data.
from_xz(source)Extracts supplied xz format archive and composes TarArchive from extracted data.
from_xz(path)Extracts supplied xz format archive and composes TarArchive from extracted data.
from_z(source)Extracts supplied Zstandard archive and composes TarArchive from extracted data.
from_z(path)Extracts supplied Zstandard archive and composes TarArchive from extracted data.
create_entry(name, path, open_immediately)Create a single entry within the archive.
create_entries(source_directory, include_root_directory)Adds to the archive all the files and directories recursively in the directory given.
extract_to_directory(destination_directory)Extracts all the files in the archive to the directory provided.

See Also