Class TarEntry

Class TarEntry

Namespace: Aspose.Zip.Tar
Assembly: Aspose.Zip.dll (25.2.0)

Represents single file within tar archive.

public class TarEntry : IArchiveFileEntry

Inheritance

objectTarEntry

Implements

IArchiveFileEntry

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties

IsDirectory

Gets a value indicating whether the entry represents directory.

public bool IsDirectory { get; }

Property Value

bool

Length

Get length of entry in bytes.

public long Length { get; }

Property Value

long

ModificationTime

Gets the modification time of the file or directory.

public DateTime ModificationTime { get; }

Property Value

DateTime

Name

Gets or sets name of the entry within archive.

public string Name { get; set; }

Property Value

string

Methods

Extract(string)

Extracts the entry to the filesystem by the path provided.

public FileSystemInfo Extract(string path)

Parameters

path string

The path to destination file. If the file already exists, it will be overwritten.

Returns

FileSystemInfo

The file info of composed file.

Examples

using (var archive = new TarArchive("archive.tar"))
{
    archive.Entries[0].Extract("data.bin");
}

Exceptions

ArgumentNullException

path is null.

SecurityException

The caller does not have the required permission to access.

ArgumentException

The path is empty, contains only white spaces, or contains invalid characters.

UnauthorizedAccessException

Access to file path is denied.

PathTooLongException

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.

NotSupportedException

File at path contains a colon (:) in the middle of the string.

FileNotFoundException

The file is not found.

DirectoryNotFoundException

The specified path is invalid, such as being on an unmapped drive.

IOException

The file is already open.

Extract(Stream)

Extracts the entry to the stream provided.

public void Extract(Stream destination)

Parameters

destination Stream

Destination stream. Must be writable.

Examples

Extract an entry of tar archive.

using (var archive = new TarArchive("archive.tar"))
{
    archive.Entries[0].Extract(httpResponseStream);
}

Exceptions

ArgumentException

destination does not support writing.

Open()

Opens the entry for extraction and provides a stream with entry content.

public Stream Open()

Returns

Stream

The stream that represents the contents of the entry.

Examples

Usage: Stream decompressed = entry.Open();

.NET 4.0 and higher - use Stream.CopyTo method: decompressed.CopyTo(httpResponse.OutputStream)

.NET 3.5 and before - copy bytes manually:

byte[] buffer = new byte[8192];
int bytesRead;
while (0 < (bytesRead = decompressed.Read(buffer, 0, buffer.Length)))
 fileStream.Write(buffer, 0, bytesRead);
```</p>

#### Remarks

Read from the stream to get original content of file. See examples section.
 English