Lz4Archive

Lz4Archive class

This class represents LZ4 archive file. Use it to extract or compose LZ4 archives.

The Lz4Archive type exposes the following members:

Constructors

NameDescription
Lz4Archive(source_stream, load_options)Initializes a new instance of the Lz4Archive class prepared for decompressing.
Lz4Archive(path, load_options)Initializes a new instance of the Lz4Archive class.
Lz4Archive(settings)Initializes a new instance of the Lz4Archive class prepared for compressing.

Properties

NameDescription
file_entriesGets entries of IArchiveFileEntry type constituting the archive.
formatGets the archive format.
nameGets name of the entry.
lengthGets the length of the entry in bytes.

Methods

NameDescription
extract(path)Extracts the archive to the file by path.
extract(destination)Extracts the archive to the stream provided.
save(output)Saves lz4 archive to the stream provided.
save(destination_file_name)Saves archive to the destination file provided.
set_source(source)Sets the content to be compressed within the archive.
set_source(tar_archive, format)Sets the content to be compressed within the archive.
set_source(path)Sets the content to be compressed within the archive.
extract_to_directory(destination_directory)Extracts content of the archive to the directory provided.
open()Opens the archive for extraction and provides a stream with archive content.

See Also