View source

class Input

package haxe.io

extended by BytesInput

@:keep

An Input is an abstract reader. See other classes in the haxe.io package for several possible implementations.

All functions which read data throw Eof when the end of the stream is reached.

Variables

read onlybigEndian:Bool

Endianness (word byte order) used when reading numbers.

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

Methods

read(nbytes:Int):Bytes

Read and return nbytes bytes.

readByte():Int

Read and return one byte.

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

Read len bytes and write them into s to the position specified by pos.

Returns the actual length of read data that can be smaller than len.

See readFullBytes that tries to read the exact amount of specified bytes.

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

Read len bytes and write them into s to the position specified by pos.

Unlike readBytes, this method tries to read the exact len amount of bytes.

readInt16():Int

Read a 16-bit signed integer.

Endianness is specified by the bigEndian property.

readInt32():Int

Read a 32-bit signed integer.

Endianness is specified by the bigEndian property.

readString(len:Int, ?encoding:Encoding):String

Read and len bytes as a string.

readUInt16():Int

Read a 16-bit unsigned integer.

Endianness is specified by the bigEndian property.