logo

class

sys::OutStream

sys::Obj
  sys::OutStream

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

Slots

charset

virtual Charset charset

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

Source

close

virtual Bool close()

Close the input 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.

Source

flush

virtual This flush()

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

Source

make

new make(OutStream out)

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.

Source

makeForStrBuf

static OutStream makeForStrBuf(StrBuf strBuf)

Make an output stream designed to write characters into the specified StrBuf. The output stream is designed to write character data, attempts to do binary writes will throw UnsupportedErr.

Source

print

virtual This print(Obj s)

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

Source

printLine

virtual This printLine(Obj obj := "")

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

Source

write

virtual This write(Int byte)

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

Source

writeBool

This writeBool(Bool b)

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

Source

writeBuf

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

Write n bytes from the specified Buf at it's 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.

Source

writeChar

This writeChar(Int char)

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

Source

writeChars

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

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

Source

writeDecimal

This writeDecimal(Decimal d)

Write a decimal as a string according to writeUtf.

Source

writeF4

This writeF4(Float r)

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

Source

writeF8

This writeF8(Float r)

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

Source

writeI2

This writeI2(Int n)

Write two bytes as a 16-bit number in network byte order. This method may be paired with InStream.readU2 or InStream.readS2. Throw IOErr on error. Return this.

Source

writeI4

This writeI4(Int n)

Write four bytes as a 32-bit number in network byte order. This method may be paired with InStream.readU4 or InStream.readS4. Throw IOErr on error. Return this.

Source

writeI8

This writeI8(Int n)

Write eight bytes as a 64-bit number in network byte order. This is paired with InStream.readS8. Throw IOErr on error. Return this.

Source

writeObj

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

Write a serialized object from the stream according to the Fan 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.

Source

writeProps

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

Write the given map of Str name/value pairs to the output stream according to the Fan 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.

Source

writeUtf

This writeUtf(Str s)

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

Source