interface IBinaryWriter in Tinman.Core.IO

Base interface for classes that sequentially write data to a binary stream.

interface	IBinaryWriter	extends	IFlushable
		base of	IDataStream
			ISerializer

Methods

Flush

Flushes all cached data.

method	Flush ()
inherited	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.

Write

Writes a number of bytes to the stream.

method	Write (ByteBuffer bytes)
params	bytes	[not-null]	The bytes to write.

Exceptions:

• TinmanException:
  
  • If the parameters are invalid.
  • If an I/O error occurs.

WriteFloat32

Writes a 32-bit floating point value to the data stream.

method	WriteFloat32 (float32 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteFloat32s

Writes 32-bit floating point values to the data stream.

method	WriteFloat32s (float32[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteFloat64

Writes a 64-bit floating point value to the data stream.

method	WriteFloat64 (float64 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteFloat64s

Writes 64-bit floating point values to the data stream.

method	WriteFloat64s (float64[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt16

Writes a signed 16-bit integer value to the data stream.

method	WriteInt16 (int16 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt16s

Writes signed 16-bit integer values to the data stream.

method	WriteInt16s (int16[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt32

Writes a signed 32-bit integer value to the data stream.

method	WriteInt32 (int32 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt32s

Writes signed 32-bit integer values to the data stream.

method	WriteInt32s (int32[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt64

Writes a signed 64-bit integer value to the data stream.

method	WriteInt64 (int64 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt64s

Writes signed 64-bit integer values to the data stream.

method	WriteInt64s (int64[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt8

Writes an 8-bit integer value to the stream.

method	WriteInt8 (int8 value)
params	value		The value to write.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.

WriteInt8s

Writes signed 8-bit integer values to the data stream.

method	WriteInt8s (int8[] array, int32 offset, int32 count)
params	array	[not-null]	The input array.
	offset	[>=0]	Index of first array element to read.
	count	[>=0]	Number of values to write.
returns			The read value.

Exceptions:

• TinmanException:
  
  • If an I/O error occurs.