Struct ArchiveEntryInfo

Contains read-only metadata about a single entry (file or directory) within a compressed archive.

Inherited Members
Namespace: Scylla.Core.Util.Compression
Assembly: ScyllaCore.dll
Syntax
public readonly struct ArchiveEntryInfo
Remarks

Instances of this struct are returned by ListEntries(string) when enumerating the contents of an archive. They carry descriptive information about each entry but do not provide access to the entry's data; use ExtractEntry(string, string) or ExtractEntryAsync(string, string, CancellationToken) to retrieve the raw bytes.

Directory entries have both UncompressedSize and CompressedSize set to zero, and their CompressionRatio returns -1. Whether empty directories are included in an archive is controlled by IncludeEmptyDirectories.

The LastModified timestamp is preserved or discarded during archiving depending on PreserveTimestamps.

Constructors

ArchiveEntryInfo(string, string, long, long, bool, DateTime, bool)

Initializes a new ArchiveEntryInfo struct with all metadata for a single archive entry.

Declaration
public ArchiveEntryInfo(string name, string fullPath, long uncompressedSize, long compressedSize, bool isDirectory, DateTime lastModified, bool isEncrypted)
Parameters
Type Name Description
string name

The leaf file or directory name, without path separators (e.g., "hero.png").
string fullPath

The full path of the entry within the archive, relative to the archive root (e.g., "assets/textures/hero.png").
long uncompressedSize

The original, uncompressed size of the entry in bytes. Pass 0 for directory entries.
long compressedSize

The compressed size of the entry as stored in the archive, in bytes. Pass 0 for directory entries.
bool isDirectory

true if this entry represents a directory; false if it is a file.
DateTime lastModified

The date and time the entry was last modified before archiving.
bool isEncrypted

true if the entry's data is encrypted within the archive; false otherwise.

Properties

CompressedSize

Gets the compressed size of the entry's data as stored in the archive, in bytes.

Declaration
public long CompressedSize { get; }
Property Value
Type Description
long

The size the entry occupies inside the compressed archive. Returns 0 for directory entries. This value can be equal to UncompressedSize when the entry is stored without compression (e.g., None).

CompressionRatio

Gets the compression efficiency of this entry as a percentage of the original size.

Declaration
public double CompressionRatio { get; }
Property Value
Type Description
double

A value in the range 0 to 100 expressing the ratio of CompressedSize to UncompressedSize multiplied by 100. A result of 100 means the data was stored without any size reduction (no compression). Lower values indicate better compression. Returns -1 for directory entries or entries with an UncompressedSize of zero, where the ratio is undefined.

FullPath

Gets the full path of this entry as stored within the archive, including all intermediate directory segments relative to the archive root.

Declaration
public string FullPath { get; }
Property Value
Type Description
string

A forward-slash-delimited path string, e.g. assets/textures/hero.png. Directory entries typically end with a trailing slash.

IsDirectory

Gets a value indicating whether this entry represents a directory rather than a file.

Declaration
public bool IsDirectory { get; }
Property Value
Type Description
bool

true if this entry is a directory; false if it is a file. Directory entries have zero for both size properties and always return -1 from CompressionRatio.

IsEncrypted

Gets a value indicating whether this entry's data is encrypted within the archive.

Declaration
public bool IsEncrypted { get; }
Property Value
Type Description
bool

true if the entry is encrypted (e.g., AES-256 in a ZIP archive created with a non-empty Password); false otherwise. Encrypted entries require the correct password when extracting via ExtractEntry(string, string) or ExtractEntryToFile(string, string, string, CompressionSettings).

LastModified

Gets the last modification timestamp of the entry as recorded in the archive.

Declaration
public DateTime LastModified { get; }
Property Value
Type Description
DateTime

The date and time the file was last modified before it was added to the archive. This value is only meaningful when the archive was created with PreserveTimestamps set to true. When timestamps are not preserved, the value reflects when the archive was created.

Name

Gets the file or directory name of this entry, without any containing path segments.

Declaration
public string Name { get; }
Property Value
Type Description
string

The leaf name component of the entry path. For example, if FullPath is assets/textures/hero.png, this property returns hero.png.

UncompressedSize

Gets the uncompressed (original) size of the entry's data in bytes.

Declaration
public long UncompressedSize { get; }
Property Value
Type Description
long

The size the entry data occupies when fully decompressed. Returns 0 for directory entries, which contain no data payload.

Methods

ToString()

Returns a human-readable string representation of this archive entry.

Declaration
public override string ToString()
Returns
Type Description
string

For directory entries, a string in the format "[DIR] {FullPath}". For file entries, a string in the format "{FullPath} ({CompressedSize}/{UncompressedSize} bytes, {CompressionRatio:F1}%)" showing the path alongside the compressed and uncompressed sizes and the compression ratio rounded to one decimal place.
Overrides

See Also