Table of Contents

Namespace FlameCsv.Attributes

Classes

CsvBooleanValuesAttribute

Overrides the converter for bool and bool?. For nullable booleans, attempts to fetch user defined null token from the options via NullTokens.

CsvConfigurationAttribute

Base class for attributes that can be used to configure a specific type.
When placed on an assembly, TargetType must be set.

CsvConstructorAttribute

Defines the constructor to be used when creating instances while reading records.

CsvConverterAttribute

Base attribute for overriding converters for the target member or parameter.

CsvConverterAttribute<TConverter>

Overrides the converter for the target member or parameter.
TConverter must have a parameterless constructor, or a public constructor with a single CsvOptions<T> parameter.

CsvConverterAttribute<T, TConverter>

Overrides the converter for the target member or parameter.
TConverter must have a parameterless constructor, or a public constructor with a single CsvOptions<T> parameter.

CsvEnumConverterAttribute<T, TEnum>

Generates a type converter for the enum type when placed on a partial class.

CsvFieldConfigurationAttribute

Base class for attributes that can be used to configure a specific property, field, or parameter.
When not placed directly on a member/parameter, MemberName must be set.

CsvHeaderAttribute

Configures the header name used when reading or writing CSV.
When not placed on a member or parameter, MemberName must be set.
When placed on an assembly, TargetType must be set.

CsvIgnoreAttribute

Ignores the member or parameter when reading or writing CSV.
Has no effect for parameters without a default value, or on init only properties.
When not placed on a member or parameter, MemberName must be set.
When placed on an assembly, TargetType must be set.

CsvIgnoredIndexesAttribute

Configures field indexes to always ignore when reading headerless CSV, or to leave empty when writing.

CsvIndexAttribute

Configures the field index used when reading or writing CSV.
When not placed on a member or parameter, MemberName must be set.
When placed on an assembly, TargetType must be set.

CsvOrderAttribute

Configures the order in which fields will be written when writing CSV (and headers matched when reading).
When not placed on a member or parameter, MemberName must be set.
When placed on an assembly, TargetType must be set.

CsvRequiredAttribute

Marks the member or parameter as required when reading CSV. required or init properties, and parameters without a default value are implicitly required.
When not placed on a member or parameter, MemberName must be set.
When placed on an assembly, TargetType must be set.

CsvStringPoolingAttribute

Configures the member to use pooled strings.

CsvTypeMapAttribute<T, TValue>

Applies source generated binding logic to the annotated partial class.

CsvTypeProxyAttribute

Configures the type used when instantiating the target type.