TarArchive.FromLZ4

FromLZ4(string)

Extracts supplied LZ4 archive and composes TarArchive from extracted data.

Important: LZ4 archive is fully extracted within this method, its content is kept internally. Beware of memory consumption.

public static TarArchive FromLZ4(string path)
ParameterTypeDescription
pathStringThe path to the archive file.

Return Value

An instance of TarArchive

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 is in an invalid format.
DirectoryNotFoundExceptionThe specified path is invalid, such as being on an unmapped drive.
FileNotFoundExceptionThe file is not found.
EndOfStreamExceptionThe file is too short.
InvalidDataExceptionThe file has the wrong signature.

Remarks

LZ4 extraction stream is not seekable by the nature of compression algorithm. Tar archive provides facility to extract arbitrary record, so it has to operate seekable stream under the hood.

See Also


FromLZ4(Stream)

Extracts supplied LZ4 archive and composes TarArchive from extracted data.

Important: LZ4 archive is fully extracted within this method, its content is kept internally. Beware of memory consumption.

public static TarArchive FromLZ4(Stream source)
ParameterTypeDescription
sourceStreamThe source of the archive.

Return Value

An instance of TarArchive

Exceptions

exceptioncondition
ArgumentExceptionCannot read from source
ArgumentNullExceptionsource is null.
EndOfStreamExceptionsource is too short.
InvalidDataExceptionThe source has the wrong signature.

Remarks

LZ4 extraction stream is not seekable by the nature of compression algorithm. Tar archive provides facility to extract arbitrary record, so it has to operate seekable stream under the hood.

See Also