Table of Contents

Class ReplayBatchResult

Namespace
Excalibur.Dispatch.ErrorHandling
Assembly
Excalibur.Dispatch.dll

The outcome of a batch replay: how many entries were selected, how many were replayed, and whether the selection was cut short by the caller's limit.

public sealed record ReplayBatchResult : IEquatable<ReplayBatchResult>
Inheritance
ReplayBatchResult
Implements
Inherited Members
Extension Methods

Remarks

A bare count cannot distinguish "1000 entries existed" from "1000 of 4000 were taken" — the operator reads a truthful-looking number and acts on a silently incomplete job. Separating the three facts makes that silence impossible to express: Truncated is the member that carries the warning, and it has no value that means "I did not check".

Truncated reports that the limit was reached, which is not the same as proving more entries remain — a filter matching exactly the limit reports true having drained the queue. This is deliberate: the honest signal is "you cannot conclude this batch was complete", and over-reporting that is safe where under-reporting it is not. Re-run until Truncated is false.

Constructors

ReplayBatchResult(int, int, bool)

The outcome of a batch replay: how many entries were selected, how many were replayed, and whether the selection was cut short by the caller's limit.

public ReplayBatchResult(int Enumerated, int Replayed, bool Truncated)

Parameters

Enumerated int

The number of entries the filter selected, up to the caller's limit.

Replayed int

The number of entries actually replayed. This can be lower than Enumerated when an individual entry could not be replayed; it is a subset of what was enumerated, never a wider claim.

Truncated bool

true when the limit was reached and further entries may match the filter, so the batch is incomplete; otherwise false.

Remarks

A bare count cannot distinguish "1000 entries existed" from "1000 of 4000 were taken" — the operator reads a truthful-looking number and acts on a silently incomplete job. Separating the three facts makes that silence impossible to express: Truncated is the member that carries the warning, and it has no value that means "I did not check".

Truncated reports that the limit was reached, which is not the same as proving more entries remain — a filter matching exactly the limit reports true having drained the queue. This is deliberate: the honest signal is "you cannot conclude this batch was complete", and over-reporting that is safe where under-reporting it is not. Re-run until Truncated is false.

Properties

Enumerated

The number of entries the filter selected, up to the caller's limit.

public int Enumerated { get; init; }

Property Value

int

Replayed

The number of entries actually replayed. This can be lower than Enumerated when an individual entry could not be replayed; it is a subset of what was enumerated, never a wider claim.

public int Replayed { get; init; }

Property Value

int

Truncated

true when the limit was reached and further entries may match the filter, so the batch is incomplete; otherwise false.

public bool Truncated { get; init; }

Property Value

bool