TarReader class final

TarReader provides sequential access to the TAR files in a TAR archive. It is designed to read from a stream and to spit out substreams for individual file contents in order to minimize the amount of memory needed to read each archive where possible.

Implemented types

• StreamIterator<TarEntry>

Constructors

TarReader(Stream<List<int>> tarStream, {int maxSpecialFileSize = defaultSpecialLength, bool disallowTrailingData = false})

Creates a tar reader reading from the raw tarStream.

Properties

current → TarEntry

The current value of the stream.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancel() → Future<void>

Cancels the stream iterator (and the underlying stream subscription) early.

override

moveNext() → Future<bool>

Reads the tar stream up until the beginning of the next logical file.

override

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

Static Methods

forEach(Stream<List<int>> tarStream, FutureOr<void> action(TarEntry entry)) → Future<void>

Utility function for quickly iterating through all entries in tarStream.