Interface ICsvPipeReader<T>

Namespace

FlameCsv.IO

Assembly

FlameCsv.Core.dll

Internal implementation detail.

[EditorBrowsable(EditorBrowsableState.Advanced)]
public interface ICsvPipeReader<T> : IDisposable, IAsyncDisposable where T : unmanaged, IBinaryInteger<T>

Type Parameters

T

Inherited Members

IDisposable.Dispose()

IAsyncDisposable.DisposeAsync()

Properties

SupportsSynchronousReads

Returns whether the reader can be used synchronously.

bool SupportsSynchronousReads { get; }

Property Value

bool

Methods

AdvanceTo(SequencePosition, SequencePosition)

Advances the reader to the specified position.

void AdvanceTo(SequencePosition consumed, SequencePosition examined)

Parameters

consumed SequencePosition

End position of the consumed data from the last read.

examined SequencePosition

End position of the examined data from the last read.

Read()

Reads the next block of data synchronously from the data source.

CsvReadResult<T> Read()

Returns

CsvReadResult<T>

A result containing the data, and a boolean indicating whether the reader has reached the end of the data source and no further data can be read.

ReadAsync(CancellationToken)

Reads the next block of data asynchronously from the data source.

ValueTask<CsvReadResult<T>> ReadAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<CsvReadResult<T>>

A result containing the data, and a boolean indicating whether the reader has reached the end of the data source and no further data can be read.

TryReset()

Attempts to reset the reader to the beginning of the data source.

bool TryReset()

Returns

bool

true if the reader was successfully reset; otherwise, false.