API reference

Classes

CsvAsyncQuery<T> Class A CSV query that runs asynchronously: await foreach over it, or the asynchronous versions of the LINQ operators that run a query (CsvAsyncQuery<T>.ToListAsync, CsvAsyncQuery<T>.CountAsync(CancellationToken), CsvAsyncQuery<T>.FirstAsync(CancellationToken) and the others), which read the CSV asynchronously. CsvDataReader Class An IDataReader over a CsvReader, for APIs that read data readers: DataTable.Load, SqlBulkCopy.WriteToServer and the like. CsvDynamicRecord Class A record read without a record type, by GetRecords<dynamic>(): its fields are members named after the header (record.Name), or Field1, Field2 and so on without a header. CsvEnumExtensions Static class · net10.0 only The overloads of Parse<T>, TryParse<T> and ParseOrNull<T> for enums, whose types are not ISpanParsable<T>: reader.Parse<Status>(2) calls the method of this class. CsvEnumerable Static class Writes the results of any query (of CSV, of a database through Entity Framework Core, or in memory) as CSV: records of CsvRecordAttribute types with their generated writers, dictionaries and dynamic records by their keys, and anything else, such as anonymous types, tuples and entities, by their public members of simple types. CsvForeignQueryPlan Class A query of another LINQ provider that a CSV query runs, such as a table of Entity Framework Core. CsvQuery<T> Class A LINQ query over CSV records: its source (CsvQueryable), and the operators applied to it. CsvQueryPlan Class How a CSV query runs: for each CSV source it reads, what the reader does; what it asks other providers for; and the operators that LINQ to Objects runs on the records. CsvQueryable Static class Creates LINQ queries over CSV records: the records of a file, a stream, text or bytes as CsvRecordAttribute types, or as CsvDynamicRecord rows for files without a record type. CsvReader Class A forward-only CSV reader. CsvRecordMapper Static class Finds the generated CsvRecordMapper<T> of a CsvRecordAttribute type. CsvRecordMapper<T> Class Reads records of type T from the columns of one reader's header. CsvRecordMember Class A member of a CsvRecordAttribute type that its generated mapper reads, as CsvRecordMapper.TryGetMembers describes it. CsvRecordWriter Static class Finds the generated CsvRecordWriter<T> of a CsvRecordAttribute type. CsvRecordWriter<T> Class Writes records of type T as fields of a CsvWriter, in the columns that a CsvRecordMapper<T> reads. CsvSeparatorStream Class A read-only stream that lets CsvReader read files whose separator is longer than one character, such as ||, or is not ASCII: it puts one byte, CsvSeparatorStream.Replacement, in place of every separator. CsvSourcePlan Class What the reader of one CSV source of a query does. CsvTable<T> Class The records of a CSV file, to query (as a CsvQuery<T>) and to change: records can be added to the file, and records that match a condition removed or changed, which rewrites the file. CsvWriter Class Writes CSV as UTF-8, RFC 4180 by default.

Records

CsvMalformedRecord Record struct Describes a malformed record passed to CsvReaderOptions.OnMalformedRecord. CsvQueryOptions Record How a CSV query reads its source, and how much of the work it pushes into the reader and to other providers. CsvReaderOptions Record Options for CsvReader. CsvRecordError Record struct Describes a record that could not be mapped to its type, passed to CsvReaderOptions.OnRecordError. CsvWriterOptions Record Options for CsvWriter.

Structs

CsvField Ref struct One field of the current record. CsvReader.AsyncEnumerator Struct Asynchronously enumerates the records of a CsvReader. CsvReader.Enumerator Struct Enumerates the records of a CsvReader. CsvRow Ref struct A view of the current record of a CsvReader.

Attributes

Exceptions

CsvFormatException Exception Thrown when CSV input is malformed and the reader was configured to reject it, and when a record cannot be read as its CsvRecordAttribute type (the cause is then the Exception.InnerException). CsvValidationException Exception Thrown when the method of a CsvValidateAttribute rejects the value of a member.

Enums

CsvFieldCountHandling Enum What the reader does when a record's field count differs from the header or first record. CsvInjection Enum What CsvWriter does with a text field that starts with one of CsvWriterOptions.InjectionCharacters, which a spreadsheet such as Excel would run as a formula when it opens the file (CSV injection). CsvMalformedDataHandling Enum What the reader does when the input breaks the quoting rules. CsvMalformedReason Enum Why a record was reported as malformed. CsvMissingFieldHandling Enum What happens when a field past the end of the current record is requested. CsvMode Enum How fields are delimited and escaped, for CsvReader and CsvWriter. CsvQuoting Enum When CsvWriter encloses fields in quotes. CsvRecordMemberKind Enum How a CsvRecordMember gets its value.

Delegates

CsvShouldQuote Delegate Decides whether CsvWriter quotes a field in CsvMode.Rfc4180 mode (CsvWriterOptions.ShouldQuote). CsvShouldSkipRecord Delegate Decides whether the reader skips a record (CsvReaderOptions.ShouldSkipRecord), such as a total or a section title in the middle of the data. CsvTryParser<T> Delegate Tries to parse a field value, for the TryParse and ParseOrNull overloads that take a parser.

Interfaces

ICsvConverter<T> Interface Reads and writes the field of a member of a CsvRecordAttribute type that has a CsvConverterAttribute, for types that cannot be read otherwise and for formats of your own.