Utf8DelimitedReader Struct

Definition

Namespace

Bodu.Text.Delimited.Reader

Assembly

Bodu.Text.Delimited.dll

Package

Bodu.Text.Delimited 1.0.0

Source

Utf8DelimitedReader.cs

Provides a high-performance, forward-only reader for delimited (RFC 4180 CSV/TSV) bytes. The reader is a ref struct, so it lives on the stack and cannot be boxed or captured.

public ref struct Utf8DelimitedReader

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

A delimited document is an array of records. A call to Read() advances to the next token and reports it through TokenType: a document StartArray frames the records; with a header each record is an object (StartObject plus PropertyName / String pairs), and without a header each record is a positional array of String fields.

Fields are decoded on demand through GetString(): surrounding quotes are removed and doubled quotes are collapsed to a single literal. ValueSpan exposes the raw source bytes of a field value.

Constructors

Utf8DelimitedReader(ReadOnlySpan<byte>)

Initializes a new instance of the Utf8DelimitedReader struct over the supplied bytes.

public Utf8DelimitedReader(ReadOnlySpan<byte> data)

Parameters

data ReadOnlySpan<byte>

The delimited source bytes.

Utf8DelimitedReader(ReadOnlySpan<byte>, DelimitedReaderOptions)

Initializes a new instance of the Utf8DelimitedReader struct over the supplied bytes using the supplied options.

public Utf8DelimitedReader(ReadOnlySpan<byte> data, DelimitedReaderOptions options)

Parameters

data ReadOnlySpan<byte>

The delimited source bytes.

options DelimitedReaderOptions

The reader options.

Properties

BytesConsumed

Gets the number of bytes consumed so far.

public readonly int BytesConsumed { get; }

Property Value

int

The read position.

Headers

Gets the header column names, available once the document array has started.

public readonly IReadOnlyList<string> Headers { get; }

Property Value

IReadOnlyList<string>

The header names, or an empty list in headerless mode.

LineNumber

Gets the 1-based line number at the current read position.

public readonly int LineNumber { get; }

Property Value

int

The current line number.

TokenType

Gets the kind of the current token.

public readonly DelimitedTokenType TokenType { get; }

Property Value

DelimitedTokenType

The current token kind.

ValueSpan

Gets the raw source bytes of the current field value, or an empty span for structural or synthesized tokens.

public readonly ReadOnlySpan<byte> ValueSpan { get; }

Property Value

ReadOnlySpan<byte>

The raw field bytes.

Methods

GetString()

Gets the decoded text of the current property-name or string token.

public readonly string GetString()

Returns

string

The decoded text.

Exceptions

InvalidOperationException

Thrown when the current token has no text.

Read()

Advances the reader to the next token.

public bool Read()

Returns

bool

true when a token was read; false at the end of the document.

Exceptions

DelimitedFormatException

Thrown when the bytes are not valid delimited text.

Applies to

Product	Versions
.NET	8, 10