class sys::OutStream

sys::Obj
  sys::OutStream

Source

OutStream is used to write binary and text data to an output stream.

charset

Charset charset

Source

The current charset used to encode Unicode characters into bytes. The default charset should always be UTF-8.

close

virtual Bool close()

Source

Close the output stream. This method is guaranteed to never throw an IOErr. Return true if the stream was closed successfully or false if the stream was closed abnormally. Default implementation does nothing and returns true.

endian

Endian endian

Source

Byte order mode for binary writes. Default is Endian.big (network byte order).

flush

virtual This flush()

Source

Flush the stream so any buffered bytes are written out. Default implementation does nothing. Throw IOErr on error. Return this.

make

new make(OutStream? out)

Source

Constructor for an OutStream which wraps another stream. All writes to this stream will be routed to the specified inner stream.

If out is null, then it is the subclass responsibility to handle writes by overriding the following methods: write and writeBuf.

print

This print(Obj? s)

Source

Convenience for writeChars(obj.toStr). If obj is null, then print the string "null". Return this.

printLine

This printLine(Obj? obj := "")

Source

Convenience for writeChars(obj.toStr + "\n"). If obj is null then print the string "null\n". Return this.

sync

virtual This sync()

Source

If this output stream is mapped to a file device, then synchronize all memory buffers to the physical storage device. Throw IOErr on error. Return this.

write

virtual This write(Int byte)

Source

Write a byte to the output stream. Throw IOErr on error. Return this.

writeBits

This writeBits(Int val, Int num)

Source

Write between 0 and 64 bits of the given integer value. Bits which are only a partial byte are bufferred in RAM until flush.

writeBool

This writeBool(Bool b)

Source

Write one byte, one if true or zero if false. This method is paired with InStream.readBool. Throw IOErr on error. Return this.

writeBuf

virtual This writeBuf(Buf buf, Int n := buf.remaining())

Source

Write n bytes from the specified Buf at its current position to this output stream. If n is defaulted to buf.remaining(), then everything left in the buffer is drained to this output stream. The buf's position is advanced n bytes upon return. Throw IOErr on error. Return this.

writeChar

This writeChar(Int char)

Source

Write one or more bytes to the stream for the specified Unicode character based on the current charset encoding. Return this.

writeChars

This writeChars(Str str, Int off := 0, Int len := str.size() - off)

Source

Write the Unicode characters in the specified string to the stream using the current charset encoding. The off arg specifies the index offset to start writing characters and len the number of characters in str to write. Return this.

writeDecimal

This writeDecimal(Decimal d)

Source

Write a decimal as a string according to writeUtf.

writeF4

This writeF4(Float r)

Source

Write four bytes as a 32-bit floating point number using configured endian order according to Float.bits32. This is paired with InStream.readF4. Throw IOErr on error. Return this.

writeF8

This writeF8(Float r)

Source

Write eight bytes as a 64-bit floating point number using configured endian order according to Float.bits. This is paired with InStream.readF8. Throw IOErr on error. Return this.

writeI2

This writeI2(Int n)

Source

Write two bytes as a 16-bit number using configured endian. This method may be paired with InStream.readU2 or InStream.readS2. Throw IOErr on error. Return this.

writeI4

This writeI4(Int n)

Source

Write four bytes as a 32-bit number using configured endian. This method may be paired with InStream.readU4 or InStream.readS4. Throw IOErr on error. Return this.

writeI8

This writeI8(Int n)

Source

Write eight bytes as a 64-bit number using configured endian. This is paired with InStream.readS8. Throw IOErr on error. Return this.

writeObj

This writeObj(Obj? obj, [Str:Obj]? options := null)

Source

Write a serialized object from the stream according to the Fantom serialization format. Throw IOErr on error. Return this.

The options may be used to specify the format of the output:

"indent": Int specifies how many spaces to indent each level. Default is 0.
"skipDefaults": Bool specifies if we should skip fields at their default values. Field values are compared according to the equals method. Default is false.
"skipErrors": Bool specifies if we should skip objects which aren't serializable. If true then we output null and a comment. Default is false.

writeProps

This writeProps(Str:Str props, Bool close := true)

Source

Write the given map of Str name/value pairs to the output stream according to the Fantom props file format (see InStream.readProps for full specification). The props are written using UTF-8 regardless of this stream's current charset. If close argument is true, then automatically close the stream. Return this.

writeUtf

This writeUtf(Str s)

Source

Write a Str in modified UTF-8 format according to the java.io.DataOutput specification. This method is paired with InStream.readUtf. Throw IOErr on error. Return this.

writeXml

This writeXml(Str str, Int mode := 0)

Source

Write a string to this output stream using XML escape sequences. By default only the < > & characters are escaped. You can use the following flags to escape additional characters:

xmlEscNewlines: escape the \n and \r characters
xmlEscQuotes: escape the single and double quote characters
xmlEscUnicode: escape any character greater than 0x7f

Any control character less than 0x20 which is not \t, \n or \r is always escaped with a numeric reference. Return this.

xmlEscNewlines