ddn.wrp.dar

Internal progress callback context stored per CreateOptions.

Compile-time and build-time feature flags for the linked libdar.

Properties are lazily initialized on first use and cached afterwards. Example usage:

import ddn.wrp.dar;
if (DarFeatures.hasZstd) writeln("Zstd compression available");

High-level interface for thread cancellation of libdar operations.

Thread cancellation allows external code to request the termination of a libdar operation running in a specific thread. The operation will abort at the next checkpoint, throwing an exception that properly cleans up resources. This does not terminate the thread itself, but causes the libdar call to return control to the caller.

Example:

import ddn.wrp.dar;
import core.thread;

// Get the thread ID before starting the operation
auto tid = ThreadCancellation.currentThreadId;

// In another thread, request cancellation:
// ThreadCancellation.cancel(tid);

// Check if cancellation is pending:
if (ThreadCancellation.isPending(tid))
    writeln("Cancellation requested");

// Clear a pending cancellation request:
ThreadCancellation.clear(tid);

High-level Archive wrapper.

This class provides an idiomatic D RAII wrapper over the low-level archive handle. It supports both creating new archives and opening existing ones for reading, with convenience methods for common operations.

Example:

import ddn.wrp.dar;

// Open an existing archive
auto arc = Archive.open("/backups", "myarchive", "dar", readOpts().toLow());

// List contents using range-based iteration
foreach (entry; arc.list())
    writefln("%s: %s", entry.type, entry.name);

// Get archive summary
auto summary = arc.summary;
writefln("Archive size: %d bytes", summary.archiveSize);

// Test archive integrity
auto result = arc.test();
writefln("Files checked: %d, Errors: %d", result.filesChecked, result.errors);

// Extract archive contents
arc.extract("/restore/path");

// Explicit cleanup (optional, destructor handles this automatically)
arc.close();

Transform provides a high-level, RAII wrapper for libdar data transforms (xform). It can read a source archive from a path/base/ext, a named pipe, or a file descriptor, and transform it to a directory (producing slices) or to a file descriptor.

Example:

import ddn.wrp.dar;

// From an existing archive on disk
auto tf = Transform.fromPath("/backups/src", "docs", "dar");
tf.toDir("/backups/xformed", "docs_xf", "dar");

Forward range over database entries (snapshot at construction).

This range collects database entries eagerly on construction via the low-level listDatabase() and then exposes standard range primitives.

High-level Database wrapper providing RAII and idiomatic methods.

Use Database.create() to create an empty database, Database.load() to load from a dumped file, add() to register archives, removeRange() to delete by index, list() to iterate entries, and dump() to save to disk.

High-level, value-type read options with sensible defaults.

Use UFCS helpers to configure and toLow() to obtain a low-level ddn.lib.dar.ReadOptions suitable for FFI calls.

High-level, value-type create options with sensible defaults.

Use UFCS helpers to configure and toLow() to obtain a low-level ddn.lib.dar.CreateOptions suitable for FFI calls.

High-level, value-type filter options with sensible defaults.

Use UFCS helpers to configure and toLow() to obtain a low-level ddn.lib.dar.FilterOptions suitable for FFI calls.

High-level, value-type incremental backup options with sensible defaults.

Use UFCS helpers to configure and toLow() to obtain a low-level ddn.lib.dar.IncrementalOptions suitable for FFI calls.

Example:

// Create incremental backup referencing a base archive
auto io = incrOpts()
             .withReference("/backups", "full_backup", "dar")
             .withChangePolicy(DarChangePolicy.DATE)
             .withMode(DarIncrMode.INCREMENTAL);
auto arc = Archive.createIncremental("/data", "/backups", "incr1", "dar",
                                     createOpts().withAllowOverwrite(true), io);

High-level, value-type merge options with sensible defaults.

Use UFCS helpers to configure and toLow() to obtain a low-level ddn.lib.dar.MergeOptions suitable for FFI calls.

Example:

// Merge two archives with compression
auto mo = mergeOpts()
             .withCompression(DarCompression.GZIP)
             .withCompressionLevel(6)
             .withSlicing(10 * 1024 * 1024);  // 10 MiB slices
auto merged = Archive.merge(baseArc, diffArc, "/backups", "merged", "dar", mo);

Input/forward range over archive root listing (snapshot at construction).

This range collects entries eagerly on construction and then provides standard range primitives: empty, front, popFront, and save.

Input range over archive root listing, produced lazily on demand.

Unlike ListingRange, this range does not eagerly collect entries. It does not pre-buffer all entries; instead, it scans the catalog to fetch only the current element when needed. This keeps memory usage bounded and proportional to the iteration progress.

Notes:

• This is an InputRange only; copying is not supported (no save).
• Iteration occurs on the same OS thread via cooperative scheduling.

Input/forward range over the children of a given path in the archive (snapshot at construction).

This range collects entries eagerly on construction and then provides standard range primitives: empty, front, popFront, and save. It is compatible with std.algorithm and foreach idioms.

Input range over the children of path, produced lazily on demand.

Yields entries one-by-one by scanning the children listing and fetching only the needed element at each step. This minimizes peak memory usage for large directories.

Notes:

• InputRange only; copying is not supported (no save).
• Cooperative scheduling on the same thread.

Interface describing user interaction operations used by libdar.

This abstraction mirrors the essential parts of libdar's user_interaction:

• message to display information
• pause to ask a yes/no question
• getString to ask for arbitrary input (optionally without echo)
• getSecuString like getString, reserved for sensitive input

A basic console implementation of UserInteraction.

By default it targets stdin/stdout. For tests and embedding scenarios, you can inject custom read/write delegates.

Internal context for bridging UserInteraction to C callbacks.

BlindUserInteraction: A UserInteraction that silently ignores all prompts.

Useful for non-interactive batch processing. All messages are discarded, pause always returns false (no), and string prompts return empty strings.

High-level, value-type options for creating a dar_slave.

Use UFCS helpers to configure and pass to Slave.create().

High-level wrapper for dar_slave functionality.

The dar_slave feature enables serving archive data through pipes for remote/network archive access. A slave process reads orders from an input pipe and sends archive data through an output pipe to a dar master process.

Use cases:

• Network archive access (archive on remote machine, dar on local)
• Tape/sequential media access
• Privilege separation (archive reader with different permissions)

Example:

auto opts = slaveOpts()
              .withFolder("/archives")
              .withBasename("backup")
              .withInputPipe("orders_fifo")
              .withOutputPipe("data_fifo");
auto slave = Slave.create(opts);
slave.run();  // Blocks until master disconnects

Keep contexts alive while low-level CreateOptions are in use.

Keep bridge contexts alive while their UserInteractionHandle is in use.