An Output is an abstract write. A specific output implementation will only have to override the [writeByte] and maybe the [write], [flush] and [close] methods. See [File.write] and [String.write] for two ways of creating an Output.

Variables

bigEndian:Bool

Available on Linux, Windows, Neko, macOS

Endianness (word byte order) used when writing numbers.

If true, big-endian is used, otherwise little-endian is used.

Methods

close ():Void

Available on Linux, Windows, Neko, macOS

Close the output.

Behaviour while writing after calling this method is unspecified.

write (s:Bytes):Void

Available on Linux, Windows, Neko, macOS

Write all bytes stored in s.

writeByte (c:Int):Void

Available on Linux, Windows, Neko, macOS

Write one byte.

writeBytes (s:Bytes, pos:Int, len:Int):Int

Available on Linux, Windows, Neko, macOS

Write len bytes from s starting by position specified by pos.

Returns the actual length of written data that can differ from len.

See writeFullBytes that tries to write the exact amount of specified bytes.

writeFullBytes (s:Bytes, pos:Int, len:Int):Void

Available on Linux, Windows, Neko, macOS

Write len bytes from s starting by position specified by pos.

Unlike writeBytes, this method tries to write the exact len amount of bytes.

writeInput (i:Input, ?bufsize:Int):Void

Available on Linux, Windows, Neko, macOS

Read all available data from i and write it.

The bufsize optional argument specifies the size of chunks by which data is read and written. Its default value is 4096.

writeInt32 (x:Int):Void

Available on Linux, Windows, Neko, macOS

Write x as 32-bit signed integer.

Endianness is specified by the bigEndian property.

writeString (s:String):Void

Available on Linux, Windows, Neko, macOS

Write s string.

writeUInt16 (x:Int):Void

Available on Linux, Windows, Neko, macOS

Write x as 16-bit unsigned integer.

Endianness is specified by the bigEndian property.