class CsvWriter in Tinman.Core.Formatting

sealed class	CsvWriter	extends	Disposable
		implements	IFlushable

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

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

Public / Constructors

CsvWriter

Creates a new instance of CsvWriter.

public constructor	CsvWriter ([Owner] ITextStream stream, CsvFormat format, LineEnding lineEnding = LineEnding.CRLF)
params	stream	[not-null]	The stream to write to.
	format		The CSV format.
	lineEnding		The line endings to emit. Defaults to CRLF.

File

Creates a new instance of CsvWriter.

[OwnerReturn]
public static method	File (Path path, CsvFormat format, CharacterEncoding encoding = null, LineEnding lineEnding = LineEnding.CRLF)
type	CsvWriter
params	path	[not-null]	Path to file to write.
	format		The CSV format.
	encoding		The character encoding to use. If null, ISO_8859_1 will be used. Defaults to null.
	lineEnding		The line endings to emit. Defaults to CRLF.
returns		[not-null]	The CsvWriter 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.

Comment

Writes comment text.

public method	Comment (string text)
params	text	[not-null]	The comment text (can be multi-line).

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.

Flush

Flushes all cached data.

public method	Flush ()
implements	IFlushable.Flush

Remarks:

Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.

In case this object represents a read-only resource, calling the Flush method has no effect.

NewLine

Begins a new line.

public method

NewLine ()

Value

Writes a single value.

public method	Value (string value)
params	value		The value to write.