Class LzipArchive
Namespace: Aspose.Zip.Lzip
Assembly: Aspose.Zip.dll (25.8.0)
This class represents a Lzip archive file. Use it to compose or extract Lzip archives.
public class LzipArchive : 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
LzipArchive(LzipArchiveSettings)
Initializes a new instance of the Aspose.Zip.Lzip.LzipArchive.
public LzipArchive(LzipArchiveSettings settings = null)Parameters
settings LzipArchiveSettings
Setting of particular lzip archive with definition of dictionary size.
LzipArchive(Stream, LzipLoadOptions)
Initializes a new instance of the Aspose.Zip.Lzip.LzipArchive class prepared for decompressing.
public LzipArchive(Stream sourceStream, LzipLoadOptions options = null)Parameters
sourceStream Stream
The source of the archive.
options LzipLoadOptions
Options to load the archive with.
Remarks
This constructor does not decompress. See Aspose.Zip.Lzip.LzipArchive.Extract(System.IO.Stream) method for decompressing.
Exceptions
sourceStream is not seekable.
sourceStream is null.
Headers do not match lzip type of archive.
LzipArchive(string, LzipLoadOptions)
Initializes a new instance of the Aspose.Zip.Lzip.LzipArchive class prepared for decompressing.
public LzipArchive(string path, LzipLoadOptions options = null)Parameters
path string
Path to the source of the archive.
options LzipLoadOptions
Options to load the archive with.
Examples
using (FileStream extractedFile = File.Open(extractedFileName, FileMode.Create))
{
using (var archive = new LzipArchive(sourceLzipFile))
{
archive.Extract(extractedFile);
}
}Remarks
This constructor does not decompress. See Aspose.Zip.Lzip.LzipArchive.Extract(System.IO.Stream) 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 not found.
The specified path is invalid, such as being on an unmapped drive.
The file is already open.
Headers do not match lzip type of archive.
Properties
Settings
Gets the setting of particular lzip archive.
public LzipArchiveSettings Settings { get; }Property Value
Exceptions
Archive has been disposed and cannot be used.
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(Stream)
Extracts lzip archive to a stream.
public void Extract(Stream destination)Parameters
destination Stream
Stream for storing decompressed data.
Examples
using (FileStream sourceLzipFile = File.Open(sourceFileName, FileMode.Open))
{
using (FileStream extractedFile = File.Open(extractedFileName, FileMode.Create))
{
using (var archive = new LzipArchive(sourceLzipFile))
{
archive.Extract(extractedFile);
}
}
}Exceptions
Archive has been disposed and cannot be used.
Archive headers and service information were not read.
Error in data in header or checksum.
Destination stream is null.
Destination stream does not support writing.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Extract(FileInfo)
Extracts lzip archive to a file.
public void Extract(FileInfo fileInfo)Parameters
fileInfo FileInfo
FileInfo for storing decompressed data.
Examples
using (FileStream lzipFile = File.Open(sourceFileName, FileMode.Open))
{
using (var archive = new LzipArchive(lzipFile))
{
archive.Extract(new FileInfo("extracted.bin"));
}
}Exceptions
Archive has been disposed and cannot be used.
Archive headers and service information were not read.
The caller does not have the required permission to open the fileInfo.
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.
fileInfo is null.
The specified path is invalid, such as being on an unmapped drive.
The file is already open.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Extract(string)
Extracts lzip archive to a file by path.
public void Extract(string path)Parameters
path string
Path to file which will store decompressed data.
Examples
using (FileStream lzipFile = File.Open(sourceFileName, FileMode.Open))
{
using (var archive = new LzipArchive(lzipFile))
{
archive.Extract("extracted.bin");
}
}Exceptions
Archive has been disposed and cannot be used.
Archive headers and service information were not read.
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.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
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
Archive has been disposed and cannot be used.
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.
In .NET Framework 4.0 and above: Thrown when the extraction is canceled via the provided cancellation token.
Save(Stream)
Saves lzip archive to the stream provided.
public void Save(Stream outputStream)Parameters
outputStream Stream
Destination stream.
Examples
using (FileStream lzFile = File.Open("archive.lz", FileMode.Create))
{
using (var archive = new LzipArchive())
{
archive.SetSource("data.bin");
archive.Save(lzFile);
}
}Remarks
outputStream must be seekable.
Exceptions
Archive has been disposed and cannot be used.
outputStream does not support seeking.
outputStream is null.
Save(string)
Saves lzip archive to 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 LzipArchive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save("result.lz");
}Exceptions
Archive has been disposed and cannot be used.
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.
Save(FileInfo)
Saves lzip 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 LzipArchive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save(new FileInfo("archive.lz"));
}Exceptions
Archive has been disposed and cannot be used.
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.
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 LzipArchive())
{
archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
archive.Save("archive.lz");
}Exceptions
Archive has been disposed and cannot be used.
The source stream is unseekable.
SetSource(FileInfo)
Sets the content to be compressed within the archive.
public void SetSource(FileInfo fileInfo)Parameters
fileInfo FileInfo
FileInfo which will be opened as input stream.
Examples
using (var archive = new LzipArchive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save("archive.lz");
}Exceptions
Archive has been disposed and cannot be used.
The caller does not have the required permission to open the fileInfo.
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.
fileInfo is null.
The specified path is invalid, such as being on an unmapped drive.
The file is already open.
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
using (var archive = new LzipArchive())
{
archive.SetSource("data.bin");
archive.Save("archive.lz");
}Exceptions
Archive has been disposed and cannot be used.
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.
