struct

Functions for working with fixed-size structures.

Summary

struct	Functions for working with fixed-size structures.
Enumerations
Type	The type of a field.
Types
Field	Represents a field in a structure.
Struct	Represents a complete structure as a sequence of fields.
Functions
make	Make a Struct based on an array of Fields.
field	Helper function to create Field records.
packBool	Pack a Boolean value into a Bytes.
packIEEE32	Pack a Number value into a Bytes in IEEE 754 binary32 floating point format.
packIEEE64	Pack a Number value into a Bytes in IEEE 754 binary64 floating point format.
packInt8	Pack a signed Number into a Bytes of width 1.
packInt16BE	Pack a signed Number into a Bytes of width 2.
packInt16LE	Pack a signed Number into a Bytes of width 2.
packInt32BE	Pack a signed Number into a Bytes of width 4.
packInt32LE	Pack a signed Number into a Bytes of width 4.
packInt64BE	Pack a signed Number into a Bytes of width 8.
packInt64LE	Pack a signed Number into a Bytes of width 8.
packUInt8	Pack a signed Number into a Bytes of width 1.
packUInt16BE	Pack an unsigned Number into a Bytes of width 2.
packUInt16LE	Pack an unsigned Number into a Bytes of width 2.
packUInt32BE	Pack an unsigned Number into a Bytes of width 4.
packUInt32LE	Pack an unsigned Number into a Bytes of width 4.
packUInt64BE	Pack an unsigned Number into a Bytes of width 8.
packUInt64LE	Pack an unsigned Number into a Bytes of width 8.
unpackBool	Unpack a Boolean from a Bytes.
unpackIEEE32	Unpack a Number from a Bytes in IEEE 754 binary32 floating point format.
unpackIEEE64	Unpack a Number from a Bytes in IEEE 754 binary64 floating point format.
unpackInt8	Unpack a Number from a Bytes of size 1.
unpackInt16BE	Unpack a Number from a Bytes of size 2.
unpackInt16LE	Unpack a Number from a Bytes of size 2.
unpackInt32BE	Unpack a Number from a Bytes of size 4.
unpackInt32LE	Unpack a Number from a Bytes of size 4.
unpackInt64BE	Unpack a Number from a Bytes of size 8.
unpackInt64LE	Unpack a Number from a Bytes of size 8.
unpackUInt8	Unpack a Number from a Bytes of size 1.
unpackUInt16BE	Unpack a Number from a Bytes of size 2.
unpackUInt16LE	Unpack a Number from a Bytes of size 2.
unpackUInt32BE	Unpack a Number from a Bytes of size 4.
unpackUInt32LE	Unpack a Number from a Bytes of size 4.
unpackUInt64BE	Unpack a Number from a Bytes of size 8.
unpackUInt64LE	Unpack a Number from a Bytes of size 8.
Struct.pack	Convert a dictionary of values into a structure.
Struct.sizeof	Return the total size of a structure definition.
Struct.unpack	Convert a structure into a dictionary of values.

Enumerations

Type

The type of a field.

Values

bool	boolean
ieee32	IEEE 754 32 bit binary floating point
ieee64	IEEE 754 64 bit binary floating point
int8	signed 8 bit integer
int16BE	signed 16 bit integer, big endian
int16LE	signed 16 bit integer, little endian
int32BE	signed 32 bit integer, big endian
int32LE	signed 32 bit integer, little endian
int64BE	signed 64 bit integer, big endian
int64LE	signed 64 bit integer, little endian
uint8	unsigned 8 bit integer
uint16BE	unsigned 16 bit integer, big endian
uint16LE	unsigned 16 bit integer, little endian
uint32BE	unsigned 32 bit integer, big endian
uint32LE	unsigned 32 bit integer, little endian
uint64BE	unsigned 64 bit integer, big endian
uint64LE	unsigned 64 bit integer, little endian
string	string
bytes	bytes

Types

Field

Represents a field in a structure.

Struct

Represents a complete structure as a sequence of fields.

Functions

make

FUNCTION make( fields: Array<Field> ): Struct

Make a Struct based on an array of Fields.

field

FUNCTION field( name: String,
type: Type,
width: Number ): Field

Helper function to create Field records.

packBool

FUNCTION packBool( b: Boolean ): Bytes

Pack a Boolean value into a Bytes.

packIEEE32

DECLARE NATIVE FUNCTION packIEEE32( n: Number ): Bytes

Pack a Number value into a Bytes in IEEE 754 binary32 floating point format.

packIEEE64

DECLARE NATIVE FUNCTION packIEEE64( n: Number ): Bytes

Pack a Number value into a Bytes in IEEE 754 binary64 floating point format.

packInt8

FUNCTION packInt8( n: Number ): Bytes

Pack a signed Number into a Bytes of width 1.

packInt16BE

FUNCTION packInt16BE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 2.

packInt16LE

FUNCTION packInt16LE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 2.

packInt32BE

FUNCTION packInt32BE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 4.

packInt32LE

FUNCTION packInt32LE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 4.

packInt64BE

FUNCTION packInt64BE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 8.

packInt64LE

FUNCTION packInt64LE( n: Number ): Bytes

Pack a signed Number into a Bytes of width 8.

packUInt8

FUNCTION packUInt8( n: Number ): Bytes

Pack a signed Number into a Bytes of width 1.

packUInt16BE

FUNCTION packUInt16BE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 2.

packUInt16LE

FUNCTION packUInt16LE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 2.

packUInt32BE

FUNCTION packUInt32BE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 4.

packUInt32LE

FUNCTION packUInt32LE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 4.

packUInt64BE

FUNCTION packUInt64BE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 8.

packUInt64LE

FUNCTION packUInt64LE( n: Number ): Bytes

Pack an unsigned Number into a Bytes of width 8.

unpackBool

FUNCTION unpackBool( b: Bytes ): Boolean

Unpack a Boolean from a Bytes.

unpackIEEE32

DECLARE NATIVE FUNCTION unpackIEEE32( b: Bytes ): Number

Unpack a Number from a Bytes in IEEE 754 binary32 floating point format.

unpackIEEE64

DECLARE NATIVE FUNCTION unpackIEEE64( b: Bytes ): Number

Unpack a Number from a Bytes in IEEE 754 binary64 floating point format.

unpackInt8

FUNCTION unpackInt8( b: Bytes ): Number

Unpack a Number from a Bytes of size 1.

unpackInt16BE

FUNCTION unpackInt16BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 2.

unpackInt16LE

FUNCTION unpackInt16LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 2.

unpackInt32BE

FUNCTION unpackInt32BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 4.

unpackInt32LE

FUNCTION unpackInt32LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 4.

unpackInt64BE

FUNCTION unpackInt64BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 8.

unpackInt64LE

FUNCTION unpackInt64LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 8.

unpackUInt8

FUNCTION unpackUInt8( b: Bytes ): Number

Unpack a Number from a Bytes of size 1.

unpackUInt16BE

FUNCTION unpackUInt16BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 2.

unpackUInt16LE

FUNCTION unpackUInt16LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 2.

unpackUInt32BE

FUNCTION unpackUInt32BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 4.

unpackUInt32LE

FUNCTION unpackUInt32LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 4.

unpackUInt64BE

FUNCTION unpackUInt64BE( b: Bytes ): Number

Unpack a Number from a Bytes of size 8.

unpackUInt64LE

FUNCTION unpackUInt64LE( b: Bytes ): Number

Unpack a Number from a Bytes of size 8.

Struct.pack

FUNCTION Struct.pack( self: Struct,
values: Dictionary<Object> ): Bytes

Convert a dictionary of values into a structure.

Struct.sizeof

FUNCTION Struct.sizeof( self: Struct ): Number

Return the total size of a structure definition.

Struct.unpack

FUNCTION Struct.unpack( self: Struct,
data: Bytes ): Dictionary<Object>

Convert a structure into a dictionary of values.