tar library

Streaming tar implementation for Dart.

To read tar files, see TarReader. To write tar files, use tarWritingSink or tarWriter.

Classes

MaybeTarFormat
Holds the possible TAR formats that a file could take.
SynchronousTarEntry
A tar entry stored in memory.
TarEntry
An entry in a tar file.
TarHeader
Header of a tar entry
TarReader
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.

Enums

OutputFormat
This option controls how long file and link names should be written.
TarFormat
A fully resolved tar format.
TypeFlag
Type flags for TarHeader.

Constants

tarConverter → const Converter<SynchronousTarEntry, List<int>>
A synchronous encoder for in-memory tar files.
tarWriter → const StreamTransformer<TarEntry, List<int>>
A stream transformer writing tar entries as byte streams.

Functions

tarConverterWith({OutputFormat format = OutputFormat.pax}) Converter<SynchronousTarEntry, List<int>>
A synchronous encoder for in-memory tar files, with custom encoding options.
tarWriterWith({OutputFormat format = OutputFormat.pax}) StreamTransformer<TarEntry, List<int>>
Creates a stream transformer writing tar entries as byte streams, with custom encoding options.
tarWritingSink(StreamSink<List<int>> output, {OutputFormat format = OutputFormat.pax}) StreamSink<TarEntry>
Create a sink emitting encoded tar files to the output sink.

Exceptions / Errors

TarException
An exception indicating that there was an issue parsing a .tar file.