CsvFileReader Class

Definition

Namespace: DataStandardizer.File.CSV

A reader that provides fast, non-cached, forward-only access to CSV data. Each call to ReadLine returns the next line as a CsvFileHeaderLine or a TRecordLine, mapping fields to model properties along the way.

Syntax

public sealed class CsvFileReader<TRecordLine> : CsvFileIoBase<TRecordLine>, IDisposable
    where TRecordLine : CsvFileRecordLine, new()

Remarks

The reader is constructed over a Stream, a TextReader, or — on .NET Standard 2.0 and later targets — a file path. When the reader creates the underlying StreamReader itself, Dispose disposes it; a caller-supplied TextReader is left open. Supplying a CsvFileOptions whose Encoding is set together with an existing TextReader throws ArgumentException; specify the encoding when creating the reader instead. The TRecordLine type argument must have a public parameterless constructor (new()).

Constructors

Constructor	Notes
`CsvFileReader(Stream csvStream)`	Reads with a default `StreamReader`. Throws `ArgumentNullException` if `csvStream` is `null`, or `ArgumentException` if the stream cannot be read.
`CsvFileReader(Stream csvStream, CsvFileOptions options)`	Honours `options.Encoding`. Throws `ArgumentNullException` if `options` is `null`.
`CsvFileReader(string csvFilePath)`	(netstandard2.0+/.NET) Opens the file with a default `StreamReader`. Throws `ArgumentNullException` if `csvFilePath` is `null`.
`CsvFileReader(string csvFilePath, CsvFileOptions options)`	(netstandard2.0+/.NET)
`CsvFileReader(TextReader reader)`	Throws `ArgumentNullException` if `reader` is `null`.
`CsvFileReader(TextReader reader, CsvFileOptions options)`	Throws `ArgumentException` if `options.Encoding` is set — specify the encoding when creating the reader.

Properties

Property	Signature	Notes
`Context`	`CsvContext Context { get; }`	The current mappers and options.

Methods

Implicit implementation

Method	Returns	Notes
`Dispose()`	`void`	Disposes the underlying reader only when the reader created it.
`ReadLine()`	`ICsvFileLine?`	Reads the next line as a `CsvFileHeaderLine` or `CsvFileRecordLine`, or `null` at end of stream. Throws `CsvFileException` on field-count, mapping, value, or duplicate-name problems.

Inherited members RegisterMapper<TMapper>() and UnregisterMapper<TMapper>() are documented on CsvFileIoBase.

Applies to

Targets netstandard1.3, netstandard2.0, net8.0, and net10.0. The string file-path constructors are available on netstandard2.0 and the .NET targets only; on netstandard1.3 construct the reader from a Stream or TextReader.