ddn.api.archive

Supported archive formats.

TAR sub-format variants.

CPIO sub-format variants.

Entry type within an archive.

Platform-specific extraction behavior for unsupported entry types.

Archive error codes.

Encryption method for encrypted archives.

Archive-related exception with a portable error code.

Capabilities declared by an archive provider.

These flags describe what operations and features a provider supports, allowing callers to make informed decisions before invoking optional features.

File permissions (POSIX-style, portable representation).

Provides a platform-independent way to represent the 12 POSIX permission bits (rwxrwxrwx + setuid/setgid/sticky) without relying on platform-specific types.

Windows-specific file attributes (stored in archives that support them).

Maps to the Windows FILE_ATTRIBUTE_* flags for round-trip preservation of Windows metadata in archives that support extended attributes.

Timestamp with optional nanosecond precision.

Stores timestamps as a Unix epoch offset (seconds + nanoseconds) to enable round-trip preservation of high-resolution timestamps across archive formats.

Metadata for an archive entry.

Contains all available information about a single item in an archive, including its type, size, timestamps, ownership, permissions, and format-specific data.

Output sink for entry content. Called repeatedly with data chunks.

Password callback for interactive password prompting. Called when an encrypted entry is encountered and no password was provided in options. Return the password, or null to skip/abort.

Progress information for archive operations.

Progress callback. Return false to cancel operation.

Options for reading archives.

Options for writing archives.

Options for a single entry being written.

Options for reading multi-volume archives.

Interface for reading archives.

Implementations are provided by archive format providers registered via registerProvider(). Use openArchive() to obtain a reader instance.

Methods that may throw ArchiveError with UNSUPPORTED_FEATURE:

• getEntry() if !capabilities.randomAccess
• extractTo() / extractAll() for format-specific limitations

Input range for iterating over archive entries.

Primed on construction (the first entry is loaded immediately). Use with foreach or range algorithms.

Example:

auto reader = openArchive("archive.zip");
foreach (entry; reader.entries()) {
   writeln(entry.path);
}
reader.close();

Interface for writing archives.

Implementations are provided by archive format providers registered via registerProvider(). Use createArchive() to obtain a writer instance.

Call finish() to finalize the archive and produce valid output. Call close() to release all resources.

Methods that may throw ArchiveError with UNSUPPORTED_FEATURE:

• addDirectory() if !capabilities.canStoreDirectories
• addSymlink() if !capabilities.canStoreSymlinks
• addHardlink() if !capabilities.canStoreHardlinks
• setComment() if !capabilities.canStoreComments
• removeEntry() if !capabilities.canUpdate
• updateEntry() if !capabilities.canUpdate

Factory function type for creating archive readers.

Factory function type for creating archive writers.

Factory function type for detecting archive format from header bytes.

Provider descriptor for archive implementations.

Each provider is uniquely identified by the combination of vendor and format. The full provider name is constructed as vendor-format (e.g., "ddn-zip").

Register providers via registerProvider(). Factory functions may be null for formats that only support reading or only support writing (e.g., RAR).

RAII wrapper for automatic ArchiveReader cleanup.

Automatically closes the reader when the wrapper goes out of scope. Supports transparent usage via alias this.

Example:

auto reader = scopedOpenArchive("archive.zip");
foreach (entry; reader.entries()) {
   writeln(entry.path);
}
// reader.close() called automatically

RAII wrapper for automatic ArchiveWriter cleanup.

Automatically calls finish() (if not already called) and close() when the wrapper goes out of scope.

Example:

{
   auto writer = scopedCreateArchive("output.zip", WriteOptions(ArchiveFormat.ZIP));
   writer.addFile("hello.txt", cast(ubyte[])"Hello, World!");
}
// writer.finish() and writer.close() called automatically

Information about a compressed archive (e.g., .tar.gz).

Describes a compound format where an inner archive is wrapped in an outer compression layer.

Sink-based compressed archive writer implementation.

Buffers all archive output in memory, then compresses and writes to the configured ContentSink when finish() is called.