Lz4Archive.SetSource

SetSource(Stream)

Sets the content to be compressed within the archive.

public void SetSource(Stream source)
ParameterTypeDescription
sourceStreamThe input stream for the archive.

Exceptions

exceptioncondition
InvalidOperationExceptionThe archive is prepared for extraction.
ObjectDisposedExceptionArchive has been disposed and cannot be used.

Examples

using (var archive = new Lz4Archive())
{
    archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
    archive.Save("archive.lz4");
}

See Also


SetSource(FileInfo)

Sets the content to be compressed within the archive.

public void SetSource(FileInfo fileInfo)
ParameterTypeDescription
fileInfoFileInfoThe reference to a file to be compressed.

Exceptions

exceptioncondition
InvalidOperationExceptionThe archive is prepared for extraction.
ObjectDisposedExceptionArchive has been disposed and cannot be used.

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");
}

See Also


SetSource(TarArchive, TarFormat)

Sets the content to be compressed within the archive.

public void SetSource(TarArchive tarArchive, TarFormat format = TarFormat.UsTar)
ParameterTypeDescription
tarArchiveTarArchiveTar archive to be compressed.
formatTarFormatDefines tar header format.

Exceptions

exceptioncondition
ObjectDisposedExceptionArchive has been disposed and cannot be used.

Remarks

Use this method to compose joint tar.lz4 archive.

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");
    }
}

See Also


SetSource(string)

Sets the content to be compressed within the archive.

public void SetSource(string path)
ParameterTypeDescription
pathStringPath to file to be compressed.

Exceptions

exceptioncondition
ArgumentNullExceptionpath is null.
SecurityExceptionThe caller does not have the required permission to access
ArgumentExceptionThe path is empty, contains only white spaces, or contains invalid characters.
UnauthorizedAccessExceptionAccess to file path is denied.
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.
NotSupportedExceptionFile at path contains a colon (:) in the middle of the string.
InvalidOperationExceptionThis archive is prepared for extraction.
ObjectDisposedExceptionArchive has been disposed and cannot be used.

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");
}

See Also