Class FixedWidthBinaryLoaderOptions

Namespace

Wolfgang.Etl.FixedWidth

Assembly

Wolfgang.Etl.FixedWidth.dll

Options for the Stream-based FixedWidthBinaryLoader<TRecord> constructors.

public sealed record FixedWidthBinaryLoaderOptions : IEquatable<FixedWidthBinaryLoaderOptions>

Inheritance

object

FixedWidthBinaryLoaderOptions

Implements

IEquatable<FixedWidthBinaryLoaderOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Supplied as the second constructor parameter, ahead of the optional logger. When the whole options object is null, or an individual property is left unset, the documented defaults below apply — defaults live on the property initializers here rather than in constructor bodies, so no constructor can accidentally diverge from them.

Options are scoped to the input shape they configure, not to the type as a whole, so every property here is meaningful for the constructor it is passed to. The base-stage configuration (ReportingInterval, MaximumItemCount, SkipItemCount, ErrorPolicy) is inherited from the Abstractions record (ADR-0009).

Properties

Encoding

Gets the Encoding used to encode text fields into each binary record. Defaults to ASCII.

public Encoding Encoding { get; init; }

Property Value

Encoding

ErrorPolicy

Gets the per-item error policy. Defaults to the abort policy the base stages use.

public Func<ItemErrorContext, ItemErrorAction> ErrorPolicy { get; init; }

Property Value

Func<ItemErrorContext, ItemErrorAction>

Exceptions

ArgumentNullException

The value is null.

MaximumItemCount

Gets the maximum number of items the stage loads. Defaults to MaxValue.

public int MaximumItemCount { get; init; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

The value is less than 1.

ReportingInterval

Gets the number of items between progress reports. Defaults to 1000.

public int ReportingInterval { get; init; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

The value is less than 1.

SkipItemCount

Gets the number of items the stage skips before the first is loaded. Defaults to 0.

public int SkipItemCount { get; init; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

The value is negative.