Struct CsvReaderOptions

Namespace

FlameCsv.IO

Assembly

FlameCsv.Core.dll

Represents options for configuring ICsvPipeReader<T>.

public readonly struct CsvReaderOptions

Fields

DefaultBufferSize

The default buffer size in T.

public const int DefaultBufferSize = 4096

Field Value

int

DefaultMinimumReadSize

The default minimum read size in T.

public const int DefaultMinimumReadSize = 1024

Field Value

int

Properties

BufferSize

Gets or sets the buffer size in T. If set to -1, the default buffer size is used.

public int BufferSize { get; init; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

Thrown if the value is less than 1 and not equal to -1.

LeaveOpen

Gets or sets a value indicating whether the inner stream/reader should be left open after reading.

public bool LeaveOpen { get; init; }

Property Value

bool

MinimumReadSize

Gets or sets the minimum read size in T. If set to -1, the default minimum read size is used.

public int MinimumReadSize { get; init; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

Thrown if the value is less than 1 and not equal to -1.

NoDirectBufferAccess

Disable direct buffer reading optimization when reading MemoryStream or StringReader with an exposable buffer.

[EditorBrowsable(EditorBrowsableState.Never)]
public bool NoDirectBufferAccess { get; init; }

Property Value

bool

Methods

EnsureValid<T>(MemoryPool<T>)

Ensures the configured buffer sizes are valid for the specified memory pool.

public void EnsureValid<T>(MemoryPool<T> memoryPool)

Parameters

memoryPool MemoryPool<T>

Pool instance

Type Parameters

T

See Also

CsvPipeReader