Class DatasetLoadOutcome

Namespace

EncDotNet.S100.Datasets.Pipelines.Catalog

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

The outcome of a LoadAsync(string, string?, CancellationToken) call.

public sealed record DatasetLoadOutcome : IEquatable<DatasetLoadOutcome>

Inheritance

object

DatasetLoadOutcome

Implements

IEquatable<DatasetLoadOutcome>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DatasetLoadOutcome(string, DatasetSourceKind, IReadOnlyList<DatasetId>, bool, IReadOnlyList<string>?)

The outcome of a LoadAsync(string, string?, CancellationToken) call.

public DatasetLoadOutcome(string Path, DatasetSourceKind Kind, IReadOnlyList<DatasetId> Added, bool TimedOut, IReadOnlyList<string>? Problems = null)

Parameters

Path string

The path that was loaded.

Kind DatasetSourceKind

How the path was classified.

Added IReadOnlyList<DatasetId>

Catalog ids of the datasets newly added, in add order. Empty when nothing portrayable was produced.

TimedOut bool

true when an exchange-set load did not quiesce before the host's ceiling; some datasets may still be arriving.

Problems IReadOnlyList<string>

Human-readable reasons the load failed or skipped datasets (for example an unreadable catalogue, or a catalogued file with an unsupported product), in the order they arose. null or empty when nothing was skipped. A tool reporting an empty Added includes these so the caller learns why nothing loaded.

Properties

Added

Catalog ids of the datasets newly added, in add order. Empty when nothing portrayable was produced.

public IReadOnlyList<DatasetId> Added { get; init; }

Property Value

IReadOnlyList<DatasetId>

Kind

How the path was classified.

public DatasetSourceKind Kind { get; init; }

Property Value

DatasetSourceKind

Path

The path that was loaded.

public string Path { get; init; }

Property Value

string

Problems

Human-readable reasons the load failed or skipped datasets (for example an unreadable catalogue, or a catalogued file with an unsupported product), in the order they arose. null or empty when nothing was skipped. A tool reporting an empty Added includes these so the caller learns why nothing loaded.

public IReadOnlyList<string>? Problems { get; init; }

Property Value

IReadOnlyList<string>

TimedOut

true when an exchange-set load did not quiesce before the host's ceiling; some datasets may still be arriving.

public bool TimedOut { get; init; }

Property Value

bool