Class Lz4Archive
Namespace: Aspose.Zip.Lz4
Assembly: Aspose.Zip.dll (25.8.0)
This class represents LZ4 archive file. Use it to extract or compose LZ4 archives.
public class Lz4Archive : IArchive, IDisposable, IArchiveFileEntryInheritance
Implements
IArchive , IDisposable , IArchiveFileEntry
Inherited Members
object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Constructors
Lz4Archive(Stream, Lz4LoadOptions)
Initializes a new instance of the Aspose.Zip.Lz4.Lz4Archive class prepared for decompressing.
public Lz4Archive(Stream sourceStream, Lz4LoadOptions loadOptions = null)Parameters
sourceStream Stream
The source of the archive.
loadOptions Lz4LoadOptions
The options to load archive with.
Examples
Open an archive from a stream and extract it to a MemoryStream
var ms = new MemoryStream();
using (Lz4Archive archive = new Lz4Archive(File.OpenRead("archive.lz4")))
archive.Open().CopyTo(ms);Remarks
This constructor does not decompress. See Aspose.Zip.Lz4.Lz4Archive.Open method for decompressing.
Exceptions
Cannot read from sourceStream
sourceStream is null.
sourceStream is too short.
The sourceStream has wrong signature.
Lz4Archive(string, Lz4LoadOptions)
Initializes a new instance of the Aspose.Zip.Lz4.Lz4Archive class.
public Lz4Archive(string path, Lz4LoadOptions loadOptions = null)Parameters
path string
The path to the archive file.
loadOptions Lz4LoadOptions
The options to load archive with.
Examples
Open an archive from file by path and extract it to a MemoryStream
var ms = new MemoryStream();
using (Lz4Archive archive = new Lz4Archive("archive.lz4"))
archive.Open().CopyTo(ms);Remarks
This constructor does not decompress. See Aspose.Zip.Lz4.Lz4Archive.Open method for decompressing.
Exceptions
path is null.
The caller does not have the required permission to access
The path is empty, contains only white spaces, or contains invalid characters.
Access to file path is denied.
The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
File at path contains a colon (:) in the middle of the string.
The file is too short.
Data in the file has the wrong signature.
Lz4Archive(Lz4ArchiveSetting)
Initializes a new instance of the Aspose.Zip.Lz4.Lz4Archive class prepared for compressing.
public Lz4Archive(Lz4ArchiveSetting settings = null)Parameters
settings Lz4ArchiveSetting
The setting of the composed archive.
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()Dispose(bool)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected virtual void Dispose(bool disposing)Parameters
disposing bool
Whether managed resources should be disposed.
Extract(string)
Extracts the archive to the file by path.
public FileInfo Extract(string path)Parameters
path string
The path to destination file. If the file already exists, it will be overwritten.
Returns
Info of an extracted file.
Exceptions
Source stream is too short.
Wrong bytes found while decoding.
This LZ4 version is not supported.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Archive has been disposed and cannot be used.
Extract(Stream)
Extracts the archive to the stream provided.
public void Extract(Stream destination)Parameters
destination Stream
Destination stream. Must be writable.
Examples
using (var archive = new Lz4Archive("archive.lz4"))
{
archive.Extract(httpResponseStream);
}Exceptions
destination does not support writing.
Source stream is too short.
Wrong bytes found while decoding.
This LZ4 version is not supported.
The archive is prepared for composition.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Archive has been disposed and cannot be used.
ExtractToDirectory(string)
Extracts content of the archive to the directory provided.
public void ExtractToDirectory(string destinationDirectory)Parameters
destinationDirectory string
The path to the directory to place the extracted files in.
Remarks
If the directory does not exist, it will be created.
Exceptions
destinationDirectory is null.
The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters and file names must be less than 260 characters.
The caller does not have the required permission to access the existing directory.
If the directory does not exist, the path contains a colon character (:) that is not part of a drive label (“C:").
destinationDirectory is a zero-length string, contains only white space, or contains one or more invalid characters. You can query for invalid characters by using the System.IO.Path.GetInvalidPathChars method.
-or- path is prefixed with, or contains, only a colon character (:).
The directory specified by path is a file. -or- The network name is not known.
Source stream is too short.
Wrong bytes found while initialize decoding.
The archive is prepared for composition.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Archive has been disposed and cannot be used.
Open()
Opens the archive for extraction and provides a stream with archive content.
public Stream Open()Returns
The stream that represents the contents of the archive.
Examples
Extracts the archive and copies extracted content to file stream.
using (var archive = new Lz4Archive("archive.lz4"))
{
using (var extracted = File.Create("data.bin"))
{
var unpacked = archive.Open();
byte[] b = new byte[8192];
int bytesRead;
while (0 < (bytesRead = unpacked.Read(b, 0, b.Length)))
extracted.Write(b, 0, bytesRead);
}
}You may use Stream.CopyTo method for .NET 4.0 and higher: `unpacked.CopyTo(extracted);`
Remarks
Read from the stream to get the original content of a file. See examples section.
Exceptions
Source stream is too short.
Wrong bytes found while initialize decoding.
The archive is prepared for composition.
Archive has been disposed and cannot be used.
Save(Stream)
Saves lz4 archive to the stream provided.
public void Save(Stream output)Parameters
output Stream
Destination stream.
Examples
using (FileStream lz4File = File.Open("archive.lz4", FileMode.Create))
{
using (var archive = new Lz4Archive())
{
archive.SetSource("data.bin");
archive.Save(lz4File);
}
}Remarks
output must be seekable.
Exceptions
output is null.
output is not writable.
The archive is prepared for extraction. - or - Source was not supplied.
In .NET Framework 4.0 and above: Thrown when the compression is canceled via the provided cancellation token.
Archive has been disposed and cannot be used.
Save(FileInfo)
Saves lz4 archive to destination file provided.
public void Save(FileInfo destination)Parameters
destination FileInfo
FileInfo, which will be opened as destination stream.
Examples
using (var archive = new Lz4Archive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save(new FileInfo("archive.lz4"));
}Exceptions
The caller does not have the required permission to open the destination.
The file path is empty or contains only white spaces.
The file is not found.
Path to file is read-only or is a directory.
destination is null.
The specified path is invalid, such as being on an unmapped drive.
The file is already open.
The archive is prepared for extraction.
Archive has been disposed and cannot be used.
Save(string)
Saves archive to the destination file provided.
public void Save(string destinationFileName)Parameters
destinationFileName string
The path of the archive to be created. If the specified file name points to an existing file, it will be overwritten.
Examples
using (var archive = new LZ4Archive())
{
archive.SetSource("data.bin");
archive.Save("archive.lz4");
}Exceptions
destinationFileName is null.
The caller does not have the required permission to access
The destinationFileName is empty, contains only white spaces, or contains invalid characters.
Access to file destinationFileName is denied.
The specified destinationFileName, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
File at destinationFileName contains a colon (:) in the middle of the string.
The archive is prepared for extraction.
Archive has been disposed and cannot be used.
SetSource(Stream)
Sets the content to be compressed within the archive.
public void SetSource(Stream source)Parameters
source Stream
The input stream for the archive.
Examples
using (var archive = new Lz4Archive())
{
archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
archive.Save("archive.lz4");
}Exceptions
The archive is prepared for extraction.
Archive has been disposed and cannot be used.
SetSource(FileInfo)
Sets the content to be compressed within the archive.
public void SetSource(FileInfo fileInfo)Parameters
fileInfo FileInfo
The reference to a file to be compressed.
Examples
Open an archive from a stream and extract it to a MemoryStream
using (var archive = new Lz4Archive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save("archive.lz4");
}Exceptions
The archive is prepared for extraction.
Archive has been disposed and cannot be used.
SetSource(TarArchive, TarFormat)
Sets the content to be compressed within the archive.
public void SetSource(TarArchive tarArchive, TarFormat format = TarFormat.UsTar)Parameters
tarArchive TarArchive
Tar archive to be compressed.
format TarFormat
Defines tar header format.
Examples
using (var tarArchive = new TarArchive())
{
tarArchive.CreateEntry("first.bin", "data1.bin");
tarArchive.CreateEntry("second.bin", "data2.bin");
using (var lz4Archive = new Lz4Archive())
{
lz4Archive.SetSource(tarArchive);
lz4Archive.Save("archive.tar.lz4");
}
}Remarks
Use this method to compose joint tar.lz4 archive.
Exceptions
Archive has been disposed and cannot be used.
SetSource(string)
Sets the content to be compressed within the archive.
public void SetSource(string path)Parameters
path string
Path to file to be compressed.
Examples
Open an archive from file by path and extract it to a MemoryStream
using (var archive = new Lz4Archive())
{
archive.SetSource("data.bin");
archive.Save("archive.lz4");
}Exceptions
path is null.
The caller does not have the required permission to access
The path is empty, contains only white spaces, or contains invalid characters.
Access to file path is denied.
The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.
File at path contains a colon (:) in the middle of the string.
This archive is prepared for extraction.
Archive has been disposed and cannot be used.
