TarArchive.SaveLZMACompressed

SaveLZMACompressed(Stream, TarFormat?)

Saves archive to the stream with LZMA compression.

public void SaveLZMACompressed(Stream output, TarFormat? format = default)
ParameterTypeDescription
outputStreamDestination stream.
formatNullable`1Defines the tar header format. Null value will be treated as USTar when possible.

Exceptions

exceptioncondition
ArgumentNullExceptionoutput is null.
ArgumentExceptionoutput is not writable.
ObjectDisposedExceptionArchive has been disposed and cannot be used

Remarks

output must be writable.

Important: tar archive is composed then compressed within this method, its content is kept internally. Beware of memory consumption.

Examples

using (FileStream result = File.OpenWrite("result.tar.lzma"))
{
    using (FileStream source = File.Open("data.bin", FileMode.Open, FileAccess.Read))
    {
        using (var archive = new TarArchive())
        {
            archive.CreateEntry("entry.bin", source);
            archive.SaveLZMACompressed(result);
        }
    }
}

See Also


SaveLZMACompressed(string, TarFormat?)

Saves archive to the file by path with lzma compression.

public void SaveLZMACompressed(string path, TarFormat? format = default)
ParameterTypeDescription
pathStringThe path of the archive to be created. If the specified file name points to an existing file, it will be overwritten.
formatNullable`1Defines the tar header format. Null value will be treated as USTar when possible.

Exceptions

exceptioncondition
UnauthorizedAccessExceptionThe caller does not have the required permission. -or- path specified a read-only file or directory.
ArgumentExceptionpath is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.
ArgumentNullExceptionpath is null.
PathTooLongExceptionThe 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.
DirectoryNotFoundExceptionThe specified path is invalid, (for example, it is on an unmapped drive).
NotSupportedExceptionpath is in an invalid format.
ObjectDisposedExceptionArchive has been disposed and cannot be used

Remarks

Important: tar archive is composed then compressed within this method, its content is kept internally. Beware of memory consumption.

Examples

using (FileStream source = File.Open("data.bin", FileMode.Open, FileAccess.Read))
{
    using (var archive = new TarArchive())
    {
        archive.CreateEntry("entry.bin", source);
        archive.SaveLZMACompressed("result.tar.lzma");
    }
}

See Also