Class CsvBufferReader

Namespace

FlameCsv.IO

Assembly

FlameCsv.Core.dll

Static class that can be used to create ICsvBufferReader<T> instances.

[EditorBrowsable(EditorBrowsableState.Advanced)]
public static class CsvBufferReader

Inheritance

object

CsvBufferReader

Methods

Create(in ReadOnlySequence<byte>, MemoryPool<byte>?, CsvIOOptions)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<byte> Create(in ReadOnlySequence<byte> csv, MemoryPool<byte>? memoryPool = null, CsvIOOptions options = default)

Parameters

csv ReadOnlySequence<byte>

CSV data

memoryPool MemoryPool<byte>

options CsvIOOptions

Returns

ICsvBufferReader<byte>

Create(in ReadOnlySequence<char>, MemoryPool<char>?, CsvIOOptions)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<char> Create(in ReadOnlySequence<char> csv, MemoryPool<char>? memoryPool = null, CsvIOOptions options = default)

Parameters

csv ReadOnlySequence<char>

CSV data

memoryPool MemoryPool<char>

options CsvIOOptions

Returns

ICsvBufferReader<char>

Create(Stream, MemoryPool<byte>?, CsvIOOptions)

Creates a new CSV reader instance from a Stream.

public static ICsvBufferReader<byte> Create(Stream stream, MemoryPool<byte>? memoryPool = null, CsvIOOptions options = default)

Parameters

stream Stream

The stream

memoryPool MemoryPool<byte>

Memory pool used; defaults to Shared.

options CsvIOOptions

Options to configure the reader

Returns

ICsvBufferReader<byte>

Remarks

If the stream is a MemoryStream, the buffer is accessed directly for zero-copy reads if possible; see NoDirectBufferAccess.

Create(Stream, Encoding?, MemoryPool<char>?, CsvIOOptions)

Creates a new CSV reader instance from a Stream and an Encoding.

public static ICsvBufferReader<char> Create(Stream stream, Encoding? encoding = null, MemoryPool<char>? memoryPool = null, CsvIOOptions options = default)

Parameters

stream Stream

The stream

encoding Encoding

Encoding used to read the bytes

memoryPool MemoryPool<char>

Memory pool used; defaults to Shared.

options CsvIOOptions

Options to configure the reader

Returns

ICsvBufferReader<char>

Remarks

If encoding is null, ASCII, or UTF8, a custom reader implementation is used for more performant reading. Use the overload with TextReader if this behavior is not desired.

Create(TextReader, MemoryPool<char>?, CsvIOOptions)

Creates a new CSV reader instance from a TextReader.

public static ICsvBufferReader<char> Create(TextReader reader, MemoryPool<char>? memoryPool = null, CsvIOOptions options = default)

Parameters

reader TextReader

The text reader

memoryPool MemoryPool<char>

Memory pool used; defaults to Shared.

options CsvIOOptions

Options to configure the reader

Returns

ICsvBufferReader<char>

Remarks

If the stream is a StringReader, the internal string is accessed directly for zero-copy reads; see NoDirectBufferAccess.

Create(ReadOnlyMemory<byte>)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<byte> Create(ReadOnlyMemory<byte> csv)

Parameters

csv ReadOnlyMemory<byte>

CSV data

Returns

ICsvBufferReader<byte>

Create(ReadOnlyMemory<char>)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<char> Create(ReadOnlyMemory<char> csv)

Parameters

csv ReadOnlyMemory<char>

CSV data

Returns

ICsvBufferReader<char>

Create(string?)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<char> Create(string? csv)

Parameters

csv string

CSV data

Returns

ICsvBufferReader<char>

Create(StringBuilder?)

Creates a new reader over the CSV data.

public static ICsvBufferReader<char> Create(StringBuilder? csv)

Parameters

csv StringBuilder

String builder containing the CSV

Returns

ICsvBufferReader<char>

Remarks

The StringBuilder must not be modified while the reader is in use.

Create<T>(in ReadOnlySequence<T>, MemoryPool<T>?, CsvIOOptions)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<T> Create<T>(in ReadOnlySequence<T> csv, MemoryPool<T>? memoryPool = null, CsvIOOptions options = default) where T : unmanaged

Parameters

csv ReadOnlySequence<T>

CSV data

memoryPool MemoryPool<T>

options CsvIOOptions

Returns

ICsvBufferReader<T>

Type Parameters

T

Create<T>(ReadOnlyMemory<T>)

Creates a new pipe reader over the CSV data.

public static ICsvBufferReader<T> Create<T>(ReadOnlyMemory<T> csv) where T : unmanaged

Parameters

csv ReadOnlyMemory<T>

CSV data

Returns

ICsvBufferReader<T>

Type Parameters

T