BinaryReader

Moves the cursor forward to the next multiple of bit_boundary, clamped to the data.

reader:seek( 3 )
reader:align() --> 8

Checks if the cursor is at a multiple of bit_boundary.

Checks if the cursor is at the end of the data.

Replaces the data of the reader and moves the cursor to the start.

Reads bytes as a string, the cursor doesn't have to be aligned.

Reads one bit.

Reads one bit as a boolean, same as net.ReadBool.

Reads bytes, the cursor doesn't have to be aligned.

Every byte is a separate return value, so use read for large amounts of data.

Creates a new instance of the class without calling __init, and reads it with its __deserialize( reader, ... ) method.

local vector = reader:readClass( Vector2 )

Reads the string prefixed with its length, written by BinaryWriter:writeCountedString.

Throws EndOfFileError if the string is cut, the cursor stays after the length in that case.

Reads date in DOS format (16 bits), see bytepack.readDate.

DOS date layout

Reads signed 8-byte (64 bit) float, the cursor doesn't have to be aligned.

IEEE 754 layout

Range: 2.2250738585072014e-308 - 1.7976931348623157e308 (normal), Lua numbers are doubles, so nothing is lost.

Reads signed fixed-point number (Qm.n), see bytepack.readFixedPoint.

Commonly Used Qm.n Formats (signed)

m + n is the size of the field in bits (1 - 64), so the range is limited to 53 bits.

Reads the string of a fixed size, same as read, but byte_count is required.

Reads signed 4-byte (32 bit) float, the cursor doesn't have to be aligned.

IEEE 754 layout

Range: 1.1754944e-38 - 3.4028235e38 (normal), integers are exact up to 16777216.

Reads signed (two's complement) integer of any size, see pack.readInt.

Signed Integers limits for bit count

Valid values without loss of precision: -9007199254740991 - 9007199254740991 (53 bits), all values above will have problems when working with them.

Reads the line terminated by \n (a trailing \r is removed), or all whole bytes left if there is no \n.

Reads the object in place with its __deserialize( reader, ... ) method.

Reads C-style string, the bytes until the null terminator (\0), or all whole bytes left if there is no terminator, same as net.ReadString.

Reads bytes until the terminator byte, or all whole bytes left if there is no terminator.

The terminator is read too, but isn't a part of the string.

local reader = BinaryReader( "key=value" )
reader:readTerminatedString( 0x3D ) --> "key", true
reader:readTerminatedString( 0x3D ) --> "value", false

Reads time in DOS format (16 bits), see bytepack.readTime.

DOS time layout

Reads unsigned integer of any size, see pack.readUInt.

Unsigned Integers limits for bit count

Valid values without loss of precision: 0 - 9007199254740991 (53 bits), all values above will have problems when working with them.

reader:readUInt( 8 ) -- byte
reader:readUInt( 32, true ) -- same as `net.ReadUInt( 32 )`

Reads unsigned fixed-point number (UQm.n), see bytepack.readFixedPoint.

Commonly Used UQm.n Formats (unsigned)

m + n is the size of the field in bits (1 - 64), so the range is limited to 53 bits.

reader:readUnsignedFixedPoint( 8, 8 ) -- UQ8.8, 16 bits

Returns the size of the data after the cursor.

Moves the cursor to the absolute position, clamped to the data.

reader:seek() --> 0, the start
reader:seek( 4, true ) --> 32, the 5th byte
reader:seek( -1, true ) --> the last byte

Returns the size of the data.

Moves the cursor relative to its position, clamped to the data.

Returns the cursor position.