ArchiveReadOptions class final

Options honored by format readers, passed through Archive.open / ArchiveFormatRegistry.openReader.

Constructors

ArchiveReadOptions({bool verifyChecksums = true, String entryNameDecoder(Uint8List nameBytes)?, String? password, Future<ByteSource?> nextVolume(int volume)?})
Creates options; the defaults are what applications normally want.
const

Properties

entryNameDecoder → String Function(Uint8List nameBytes)?
Caller-supplied decoder for entry names whose encoding the format does not record reliably: ZIP entries without the UTF-8 flag are the classic case (manga archives from assorted tools are often Shift-JIS). When set, it receives the raw stored name bytes and its result replaces the default strict-UTF-8-then-CP437 heuristic. Names that declare UTF-8 (ZIP general-purpose bit 11) are decoded as UTF-8 regardless. Exceptions thrown by the decoder propagate to the caller.
final
hashCode → int
The hash code for this object.
no setterinherited
nextVolume → Future<ByteSource?> Function(int volume)?
Resolver for the later parts of a multi-volume archive (a set split across name.part1.rar, name.part2.rar, … or name.rar, name.r00, …). Volume 1 is the source passed to the reader; the reader calls this with the 1-based number of each subsequent volume it needs (2, 3, …) and expects that volume's ByteSource, or null when there is no such volume.
final
password → String?
Password for encrypted archives (Phase 3, doc/encryption-scope.md).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
verifyChecksums → bool
Verify content checksums recorded by the format (CRC-32 for ZIP and gzip) while streaming; a mismatch errors the stream at its end with a ChecksumMismatchException. On by default; disable only for forensic reads of damaged archives.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited