Interface Csv.IReadBuilder<T>

Namespace

FlameCsv

Assembly

FlameCsv.Core.dll

Builder to create a CSV reading pipeline from.

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

Type Parameters

T

Inherited Members

Csv.IReadBuilderBase<T, Csv.IReadBuilder<T>>.IOOptions

Csv.IReadBuilderBase<T, Csv.IReadBuilder<T>>.WithIOOptions(in CsvIOOptions)

Csv.IReadBuilderBase<T, Csv.IReadBuilder<T>>.CreateReader(bool)

Csv.IReadBuilderBase<T, Csv.IReadBuilder<T>>.AsParallel(CsvParallelOptions)

Csv.IReadBuilderBase<T, Csv.IReadBuilder<T>>.ToReader(CsvOptions<T>)

Methods

Enumerate(CsvOptions<T>?)

Enumerates CSV records from the underlying data.

CsvRecordEnumerable<T> Enumerate(CsvOptions<T>? options = null)

Parameters

options CsvOptions<T>

Options to use, Default used by default

Returns

CsvRecordEnumerable<T>

An enumerable that yields CsvRecord<T> instances from the CSV data in a forward-only fashion.

Remarks

CsvRecord<T> instances are only valid until MoveNext() or Dispose() is called on the enumerator. The returned enumerator is intended to be only used in a foreach loop, not in LINQ.

EnumerateAsync(CsvOptions<T>?)

Enumerates CSV records asynchronously from the underlying data.

CsvRecordAsyncEnumerable<T> EnumerateAsync(CsvOptions<T>? options = null)

Parameters

options CsvOptions<T>

Options to use, Default used by default

Returns

CsvRecordAsyncEnumerable<T>

An enumerable that yields CsvRecord<T> instances from the CSV data in a forward-only fashion.

Remarks

CsvRecord<T> instances are only valid until MoveNextAsync() or DisposeAsync() is called on the enumerator. The returned enumerator is intended to be only used in an await foreach loop, not in LINQ.

ReadAsync<TValue>(CsvTypeMap<T, TValue>, CsvOptions<T>?)

Reads CSV records as TValue, binding them using the given type map.

IAsyncEnumerable<TValue> ReadAsync<TValue>(CsvTypeMap<T, TValue> typeMap, CsvOptions<T>? options = null)

Parameters

typeMap CsvTypeMap<T, TValue>

Type map used to bind the CSV data

options CsvOptions<T>

Options to use, Default used by default

Returns

IAsyncEnumerable<TValue>

An enumerable that parses TValue instances from the CSV data in a forward-only fashion.

Type Parameters

TValue

Remarks

The enumerator cannot be reused.
The returned enumerable must be disposed after use, either explicitly or using foreach.

ReadAsync<TValue>(CsvOptions<T>?)

Reads CSV records as TValue, binding them using reflection.

[RequiresUnreferencedCode("This code path uses reflection. Use the overloads accepting source generated CsvTypeMap for AOT/trimming compatible code.")]
[RequiresDynamicCode("This code path uses compiled expressions. Use the overloads accepting source generated CsvTypeMap for AOT/trimming compatible code.")]
IAsyncEnumerable<TValue> ReadAsync<TValue>(CsvOptions<T>? options = null)

Parameters

options CsvOptions<T>

Options to use, Default used by default

Returns

IAsyncEnumerable<TValue>

An enumerable that parses TValue instances from the CSV data in a forward-only fashion.

Type Parameters

TValue

Remarks

The enumerator cannot be reused.
The returned enumerable must be disposed after use, either explicitly or using foreach.

Read<TValue>(CsvTypeMap<T, TValue>, CsvOptions<T>?)

Reads CSV records as TValue, binding them using the given type map.

IEnumerable<TValue> Read<TValue>(CsvTypeMap<T, TValue> typeMap, CsvOptions<T>? options = null)

Parameters

typeMap CsvTypeMap<T, TValue>

Type map used to bind the CSV data

options CsvOptions<T>

Options to use, Default used by default

Returns

IEnumerable<TValue>

An enumerable that parses TValue instances from the CSV data in a forward-only fashion.

Type Parameters

TValue

Remarks

The returned enumerable must be disposed after use, either explicitly or using foreach.

See Also

Read<TValue>(CsvOptions<T>?)

Read<TValue>(CsvOptions<T>?)

Reads CSV records as TValue, binding them using reflection.

[RequiresUnreferencedCode("This code path uses reflection. Use the overloads accepting source generated CsvTypeMap for AOT/trimming compatible code.")]
[RequiresDynamicCode("This code path uses compiled expressions. Use the overloads accepting source generated CsvTypeMap for AOT/trimming compatible code.")]
IEnumerable<TValue> Read<TValue>(CsvOptions<T>? options = null)

Parameters

options CsvOptions<T>

Options to use, Default used by default

Returns

IEnumerable<TValue>

An enumerable that parses TValue instances from the CSV data in a forward-only fashion.

Type Parameters

TValue

Remarks

The enumerator cannot be reused.
The returned enumerable must be disposed after use, either explicitly or using foreach.

See Also

Read<TValue>(CsvTypeMap<T, TValue>, CsvOptions<T>?)