Create a reader with metadata and a TextReader.
The metadata defining the file structure
The TextReader to read from
OptionalimmediatelyReadHeader: booleanWhether to automatically read header lines (default: true)
Create a reader with input text but no metadata. You must call loadMeta() before reading.
The text content to read
OptionalimmediatelyReadHeader: booleanWhether to automatically read header lines (default: true)
Create a reader with a TextReader but no metadata. You must call loadMeta() before reading.
The TextReader to read from
OptionalimmediatelyReadHeader: booleanWhether to automatically read header lines (default: true)
Protected_Protected_OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonEvent fired when seeking through records.
OptionalonEvent fired when needing to access file to get meta. This library is browser-compatible and does not have direct file system access, so this event allows the consumer to provide file content as text.
Event fired when needing to access URL to get meta. Deferred to consumer as need to handle encoding and also must be returned synchronously
OptionalonProtected Static ReadonlyCarriageProtected Static ReadonlyCarriageProtected Static ReadonlyLineStatic ReadonlyPrefixProtected Static ReadonlySignatureProtected Static ReadonlyVersionStatic ReadonlyVersionStatic ReadonlyVersionProtected Static ReadonlyVersionGets the active field index for the current line.
Gets or sets whether Read() will automatically continue reading records when new tables begin.
Gets whether the fielded text stream was declared (has |!Fielded Text^| signature).
Gets whether the header has been fully read.
Gets the number of heading lines read.
Gets the line position where extra characters started being ignored.
Gets whether the reader is closed.
Gets the last line read as a string.
Gets the type of the last line read.
Gets the meta reference (file path or URL).
Gets the meta reference type.
Gets whether the last record read was the start of a new table.
Gets the number of records read (accounting for table start peeking).
Gets the number of tables read (accounting for table start suspension).
Close the reader and reset state.
ProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireGet a field value by index.
Get a field value by name.
ProtectedgetProtectedgetProtectedinternalLoad metadata from a pre-parsed FtMeta object.
The metadata to load.
Alias for nextTable() (IDataReader compatibility).
true if a new table was found, false if at end of stream.
Move to the next table in the stream.
true if a new table was found, false if at end of stream.
Open the reader with a text string.
Text reader or string providing the data to read
Whether to automatically read header lines (default: true)
Read the next record from the stream. Respects autoNextTable setting for table boundaries.
true if a record was read, false otherwise.
Read the header (declaration, embedded meta, heading lines).
Read the next line from the stream. Always reads regardless of table boundaries.
true if a line was read, false if at end of stream.
Read the next record and indicate table boundaries. Always reads regardless of table boundaries.
Result indicating same table, new table, or no more records.
Read all remaining records. Normally used with event handlers.
ProtectedredirectProtectedresetReset serialization state.
Seek to a specific record offset.
The 1-based record offset to seek to.
true if seek succeeded, false if offset beyond end.
Seek to the end of the stream.
ProtectedsetProtectedsetProtectedunredirect
High-level reader for fielded text files. Provides a convenient API for reading CSV and other delimited/fixed-width text. This is a thin wrapper around SerializationReader with simpler constructors.