tango.io.protocol.model.IWriter

License:

BSD style: see license.txt

Version:

Mar 2004: Initial release Dec 2006: Outback release

Author:

Kris Ivan Senji (the "alias put" idea)
class IWriter [abstract] #
IWriter interface. Writers provide the means to append formatted data to an IBuffer, and expose a convenient method of handling a variety of data types. In addition to writing native types such as integer and char[], writers also process any class which has implemented the IWritable interface (one method).
All writers support the full set of native data types, plus their fundamental array variants. Operations may be chained back-to-back.

Writers support a Java-esque put() notation. However, the Tango style is to place IO elements within their own parenthesis, like so: 

1

write (count) (" green bottles");

Note that each written element is distict; this style is affectionately known as "whisper". The code below illustrates basic operation upon a memory buffer: 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

auto buf = new Buffer (256);

// map same buffer into both reader and writer
auto read = new Reader (buf);
auto write = new Writer (buf);

int i = 10;
long j = 20;
double d = 3.14159;
char[] c = "fred";

// write data types out
write (c) (i) (j) (d);

// read them back again
read (c) (i) (j) (d);


// same thing again, but using put() syntax instead
write.put(c).put(i).put(j).put(d);
read.get(c).get(i).get(j).get(d);

Writers may also be used with any class implementing the IWritable interface, along with any struct implementing an equivalent function.

IWriter put(bool x) [abstract] #
IWriter put(ubyte x) [abstract] #
IWriter put(byte x) [abstract] #
IWriter put(ushort x) [abstract] #
IWriter put(short x) [abstract] #
IWriter put(uint x) [abstract] #
IWriter put(int x) [abstract] #
IWriter put(ulong x) [abstract] #
IWriter put(long x) [abstract] #
IWriter put(float x) [abstract] #
IWriter put(double x) [abstract] #
IWriter put(real x) [abstract] #
IWriter put(char x) [abstract] #
IWriter put(wchar x) [abstract] #
IWriter put(dchar x) [abstract] #
IWriter put(byte[] x) [abstract] #
IWriter put(short[] x) [abstract] #
IWriter put(int[] x) [abstract] #
IWriter put(long[] x) [abstract] #
IWriter put(ubyte[] x) [abstract] #
IWriter put(ushort[] x) [abstract] #
IWriter put(uint[] x) [abstract] #
IWriter put(ulong[] x) [abstract] #
IWriter put(float[] x) [abstract] #
IWriter put(double[] x) [abstract] #
IWriter put(real[] x) [abstract] #
IWriter put(char[] x) [abstract] #
IWriter put(wchar[] x) [abstract] #
IWriter put(dchar[] x) [abstract] #
These are the basic writer methods
IWriter put(IWritable) [abstract] #
This is the mechanism used for binding arbitrary classes to the IO system. If a class implements IWritable, it can be used as a target for IWriter put() operations. That is, implementing IWritable is intended to transform any class into an IWriter adaptor for the content held therein
IWriter newline() [abstract] #
Emit a newline
IWriter flush() [abstract] #
IWriter put() [abstract] #
Flush the output of this writer. Throws an IOException if the operation fails. These are aliases for each other
IBuffer buffer() [abstract] #
Return the associated buffer
interface IWritable #
Interface to make any class compatible with any IWriter