Struct CsvSheet

Namespace

ExcelReader.Core.Reader.Csv

Assembly

ExcelReader.Core.dll

The single, unnamed sheet of a CsvReader. A value that holds no resources.

public readonly record struct CsvSheet : IExcelSheet, IExcelSheet<IExcelRowEnumerator>, IExcelSheet<CsvReader.Enumerator>, IEquatable<CsvSheet>

Implements

IExcelSheet

IExcelSheet<IExcelRowEnumerator>

IExcelSheet<CsvReader.Enumerator>

IEquatable<CsvSheet>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ArrowConversionExtensions.ToArrowRecordBatch(IExcelSheet, ArrowReadOptions?)

Properties

Index

Gets the sheet's zero-based position in its workbook.

public int Index { get; }

Property Value

int

IsDate1904

Gets a value indicating whether the sheet's workbook uses the 1904 date system.

public bool IsDate1904 { get; }

Property Value

bool

Name

Gets the sheet name. Always the empty string, since a CSV source has a single, unnamed sheet.

public string Name { get; }

Property Value

string

Visibility

Gets the sheet's visibility. Always Visible: delimited text has no tab bar to hide from.

public ExcelSheetVisibility Visibility { get; }

Property Value

ExcelSheetVisibility

Methods

GetAsyncEnumerator(CancellationToken)

Gets a new enumerator that reads the sheet's rows asynchronously from the start.

public CsvReader.Enumerator GetAsyncEnumerator(CancellationToken ct = default)

Parameters

ct CancellationToken

A token observed by that deferred setup and by every MoveNextAsync() call.

Returns

CsvReader.Enumerator

Remarks

Setup that needs I/O, such as opening the sheet part or loading shared strings, runs on the first MoveNextAsync(), so this call does not block.

Exceptions

ObjectDisposedException

The sheet's workbook was disposed.

InvalidOperationException

The source is a CSV over a non-seekable stream that was already enumerated.

InvalidOperationException

The source is a non-seekable stream that was already enumerated.

GetEnumerator()

Gets a new enumerator that reads the sheet's rows synchronously from the start.

public CsvReader.Enumerator GetEnumerator()

Returns

CsvReader.Enumerator

Exceptions

ObjectDisposedException

The sheet's workbook was disposed.

InvalidOperationException

The source is a CSV over a non-seekable stream that was already enumerated.

InvalidOperationException

The source is a non-seekable stream that was already enumerated.