Class ArchiveResult

Namespace

Archiver.Core.Models

Assembly

Archiver.Core.dll

public sealed record ArchiveResult : IEquatable<ArchiveResult>

Inheritance

object

ArchiveResult

Implements

IEquatable<ArchiveResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CreatedFiles

public IReadOnlyList<string> CreatedFiles { get; init; }

Property Value

IReadOnlyList<string>

Errors

public IReadOnlyList<ArchiveError> Errors { get; init; }

Property Value

IReadOnlyList<ArchiveError>

FullyProcessedSources

Sources that may be deleted after the operation: exactly those whose Outcome is Completed.

public IEnumerable<string> FullyProcessedSources { get; }

Property Value

IEnumerable<string>

KeptExistingFiles

Entries not extracted because the file already existed and the conflict choice was to keep it (T-F313). The ZIP engine names them here and not in SkippedFiles, so they do not change Outcome; the tar engine lists the same case as a skip.

public IReadOnlyList<SkippedFile> KeptExistingFiles { get; init; }

Property Value

IReadOnlyList<SkippedFile>

Outcome

What the operation achieved (T-F260): errors win, then whether anything at all was done — an output was created or a source was processed — decides between skips and nothing. Warnings only tell a clean run from one with something to show (T-F280).

public OperationOutcome Outcome { get; }

Property Value

OperationOutcome

RecoveryChecks

The PAR2 check of each tested archive that has a set (T-F275 step 3); filled only by TestAsync(IReadOnlyList<string>, IProgress<ProgressReport>?, Func<PasswordPromptInfo, Task<PasswordDecision>>?, bool, CancellationToken) with verifyRecoveryData.

public IReadOnlyList<RecoveryCheck> RecoveryChecks { get; init; }

Property Value

IReadOnlyList<RecoveryCheck>

RecoveryFiles

The PAR2 files written next to the archives in CreatedFiles (T-F275, RecoveryPercent): an index and a volume per archive.

public IReadOnlyList<string> RecoveryFiles { get; init; }

Property Value

IReadOnlyList<string>

SkippedFiles

public IReadOnlyList<SkippedFile> SkippedFiles { get; init; }

Property Value

IReadOnlyList<SkippedFile>

Sources

One entry per source the engine finished looking at (T-F260). A source with no entry here was not processed — the list is fail-closed by construction.

public IReadOnlyList<SourceResult> Sources { get; init; }

Property Value

IReadOnlyList<SourceResult>

Success

No errors — the same as Outcome not being Failed.

public bool Success { get; }

Property Value

bool

Warnings

What the user should know although everything asked was done (T-F280). A warning never fails the operation and never makes a source undeletable.

public IReadOnlyList<ArchiveWarning> Warnings { get; init; }

Property Value

IReadOnlyList<ArchiveWarning>