Class CsvDataReader

Provides a way of reading a forward-only stream of rows from a CSV based data source. This class cannot be inherited.

Inheritance
System.Object
System.Data.Common.DbDataReader
StringDataReader
CsvDataReader
Implements
System.Collections.IEnumerable
System.Data.IDataReader
System.Data.IDataRecord
System.IDisposable
Inherited Members
System.Data.Common.DbDataReader.Dispose()
System.Data.Common.DbDataReader.GetData(System.Int32)
System.Data.Common.DbDataReader.GetDbDataReader(System.Int32)
System.Data.Common.DbDataReader.GetFieldValue<T>(System.Int32)
System.Data.Common.DbDataReader.GetFieldValueAsync<T>(System.Int32)
System.Data.Common.DbDataReader.GetFieldValueAsync<T>(System.Int32, System.Threading.CancellationToken)
System.Data.Common.DbDataReader.GetProviderSpecificFieldType(System.Int32)
System.Data.Common.DbDataReader.GetProviderSpecificValue(System.Int32)
System.Data.Common.DbDataReader.GetProviderSpecificValues(System.Object[])
System.Data.Common.DbDataReader.GetStream(System.Int32)
System.Data.Common.DbDataReader.GetTextReader(System.Int32)
System.Data.Common.DbDataReader.IsDBNullAsync(System.Int32)
System.Data.Common.DbDataReader.IsDBNullAsync(System.Int32, System.Threading.CancellationToken)
System.Data.Common.DbDataReader.NextResultAsync()
System.Data.Common.DbDataReader.NextResultAsync(System.Threading.CancellationToken)
System.Data.Common.DbDataReader.ReadAsync()
System.Data.Common.DbDataReader.ReadAsync(System.Threading.CancellationToken)
System.Data.Common.DbDataReader.System.Data.IDataRecord.GetData(System.Int32)
System.Data.Common.DbDataReader.System.Data.IDataReader.Close()
System.Data.Common.DbDataReader.System.Data.IDataReader.GetSchemaTable()
System.Data.Common.DbDataReader.VisibleFieldCount
Namespace: Cuemon.Data.CsvClient
Assembly: Cuemon.Data.dll
Syntax
public sealed class CsvDataReader : StringDataReader, IEnumerable, IDataReader, IDataRecord, IDisposable

Constructors

| Improve this Doc

CsvDataReader(StreamReader, String)

Initializes a new instance of the CsvDataReader class.

Declaration
public CsvDataReader(StreamReader reader, string header)
Parameters
Type Name Description
System.IO.StreamReader reader

The System.IO.StreamReader object that contains the CSV data.
System.String header

The header defining the columns of the CSV data.
Exceptions
Type Condition
System.ArgumentException

header does not contain comma (",") as delimiter.
System.ArgumentNullException

reader is null -or- header is null.
ArgumentEmptyException

header is empty.
| Improve this Doc

CsvDataReader(StreamReader, String, String)

Initializes a new instance of the CsvDataReader class.

Declaration
public CsvDataReader(StreamReader reader, string header, string delimiter)
Parameters
Type Name Description
System.IO.StreamReader reader

The System.IO.StreamReader object that contains the CSV data.
System.String header

The header defining the columns of the CSV data.
System.String delimiter

The delimiter specification.
Remarks

The default implementation uses comma (",") as delimiter.

Exceptions
Type Condition
System.ArgumentException

header does not contain the specified delimiter.
System.ArgumentNullException

reader is null -or- header is null -or- delimiter is null.
ArgumentEmptyException

header is empty -or- delimiter is empty.
| Improve this Doc

CsvDataReader(StreamReader, String, String, Func<String, Object>)

Initializes a new instance of the CsvDataReader class.

Declaration
public CsvDataReader(StreamReader reader, string header, string delimiter, Func<string, object> parser)
Parameters
Type Name Description
System.IO.StreamReader reader

The System.IO.StreamReader object that contains the CSV data.
System.String header

The header defining the columns of the CSV data.
System.String delimiter

The delimiter specification.
System.Func<System.String, System.Object> parser

The function delegate that returns a primitive object whose value is equivalent to the provided System.String value.
Remarks

The default implementation uses FromString(String) as parser.

Exceptions
Type Condition
System.ArgumentException

header does not contain the specified delimiter.
System.ArgumentNullException

reader is null -or- header is null -or- delimiter is null -or- parser is null.
ArgumentEmptyException

header is empty -or- delimiter is empty.

Properties

| Improve this Doc

Delimiter

Gets the delimiter used to separate fields of this instance.

Declaration
public string Delimiter { get; }
Property Value
Type Description
System.String

The delimiter used to separate fields of this instance.
| Improve this Doc

HasRows

Gets a value that indicates whether this System.Data.Common.DbDataReader contains one or more rows.

Declaration
public override bool HasRows { get; }
Property Value
Type Description
System.Boolean

true if this instance has rows; otherwise, false.
Overrides
System.Data.Common.DbDataReader.HasRows
| Improve this Doc

Header

Gets the header that defines the field names of this instance.

Declaration
public string[] Header { get; }
Property Value
Type Description
System.String[]

The header that defines the field names of this instance.

Methods

| Improve this Doc

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
| Improve this Doc

ReadNext()

Advances this instance to the next line of the CSV data source.

Declaration
protected override bool ReadNext()
Returns
Type Description
System.Boolean

true if there are more lines; otherwise, false.
Overrides

Implements

System.Collections.IEnumerable
System.Data.IDataReader
System.Data.IDataRecord
System.IDisposable

Extension Methods