Interface Csv.IReadBuilderBase<T, TSelf>

Namespace

FlameCsv

Assembly

FlameCsv.Core.dll

Base builder to create a CSV reading pipeline from.

public interface Csv.IReadBuilderBase<T, TSelf> where T : unmanaged, IBinaryInteger<T> where TSelf : Csv.IReadBuilderBase<T, TSelf>

Type Parameters

T

TSelf

Properties

IOOptions

Options to configure I/O for the CSV reader, such as buffer size and buffer pool.

CsvIOOptions IOOptions { get; }

Property Value

CsvIOOptions

Methods

AsParallel(CsvParallelOptions)

Configures the builder to read CSV data in parallel.

Csv.IParallelReadBuilder<T> AsParallel(CsvParallelOptions parallelOptions = default)

Parameters

parallelOptions CsvParallelOptions

Options to use for parallel reading. You can pass a cancellation token to implicitly convert it to CsvParallelOptions.

Returns

Csv.IParallelReadBuilder<T>

CreateReader(bool)

Creates a CSV buffer reader from the builder.

ICsvBufferReader<T> CreateReader(bool isAsync)

Parameters

isAsync bool

Hint to the builder how the data will be read, for example to configure Asynchronous. The builder is free to ignore this parameter.

Returns

ICsvBufferReader<T>

ToReader(CsvOptions<T>?)

Returns a reader instance that can be used to enumerate the raw CSV data. The reader can be used directly in a foreach or await foreach loop.

CsvReader<T> ToReader(CsvOptions<T>? options = null)

Parameters

options CsvOptions<T>

Options to use, Default used by default

Returns

CsvReader<T>

A reader instance that reads CSV records from the data source.

WithIOOptions(in CsvIOOptions)

Configures the builder to use the given I/O options.

TSelf WithIOOptions(in CsvIOOptions ioOptions)

Parameters

ioOptions CsvIOOptions

Options to configure the buffer size and other IO related options

Returns

TSelf