class CsvReader in Tinman.Core.Formatting

sealed class

CsvReader

extends

Disposable

Public / Attributes

Header

The header columns.

public property	Header { get }
type	IVectorConst<string>
value	[not-null]	The header columns. Will be empty until ReadHeader is called.

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Constructors

CsvReader

Creates a new instance of CsvReader.

public constructor	CsvReader ([Owner] ITextStream reader, CsvFormat format)
params	reader	[not-null]	The text to parse.
	format		The CSV format.

File

Creates a new instance of CsvReader.

[OwnerReturn]
public static method	File (Path path, CsvFormat format, CharacterEncoding encoding = null)
type	CsvReader
params	path	[not-null]	Path to file to parse.
	format		The CSV format.
	encoding		The character encoding to use. If null, ISO_8859_1 will be used. Defaults to null.
returns		[not-null]	The CsvReader object.

Text

Creates a new instance of CsvReader.

[OwnerReturn]
public static method	Text (string text, CsvFormat format)
type	CsvReader
params	text	[not-null]	The text to parse.
	format		The CSV format.
returns		[not-null]	The CsvReader object.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

ReadHeader

Reads the next row and uses the column values as headings.

public method

ReadHeader ()

ReadLine

Reads the next row.

public method	ReadLine ()
type	string[]
returns		[not-null]	The column values.