KioArch/com.sorrowblue.kioarch/ArchiveEntry

ArchiveEntry

data class ArchiveEntry(val index: Int, val name: String, val size: Long, val compressedSize: Long, val isDirectory: Boolean, val crc: Long)(source)

Metadata describing a single file or directory entry within an archive.

Instances are retrieved via ArchiveReader.getEntries and passed to ArchiveReader.extractEntry (or the extract / extractToByteArray extensions) to decompress the entry's payload.

Constructors

ArchiveEntry

constructor(index: Int, name: String, size: Long, compressedSize: Long, isDirectory: Boolean, crc: Long)

Properties

compressedSize

val compressedSize: Long

Compressed size of the entry in bytes as reported by the archive backend.

crc

val crc: Long

Unsigned 32-bit CRC-32 checksum of the uncompressed entry data stored in the lower 32 bits, or 0 for formats that do not record per-entry CRC values (such as .tar.gz or .bz2).

index

val index: Int

Zero-based positional index of this entry within the archive's entry table.

isDirectory

val isDirectory: Boolean

true if this entry represents a directory; false if it represents a regular file.

name

val name: String

Relative path of the entry inside the archive, normalized to use forward slashes (/).

size

val size: Long

Uncompressed size of the entry in bytes, or 0 for directories.

Functions

extract

@ObjCName(name = "extract", swiftName = "extract")

fun ArchiveEntry.extract(reader: ArchiveReader, sink: Sink)

Extracts the uncompressed content of this entry from reader and writes it into sink.

extractToByteArray

@ObjCName(name = "extractToByteArray", swiftName = "extractToByteArray")

fun ArchiveEntry.extractToByteArray(reader: ArchiveReader): ByteArray

Extracts the uncompressed content of this entry from reader into a new in-memory ByteArray.