Module data

Direct memory access and manipulation.

Functions

__len ()
__tostring ()
checksum ([offset[, length]])
getbyte (offset)
getint16 (offset)
getint32 (offset)
getint64 (offset)
getint8 (offset)
getnumber (offset)
getstring (offset[, length])
getuint16 (offset)
getuint32 (offset)
getuint8 (offset)
new (size)
resize (new_size)
setbyte (offset, value)
setint16 (offset, value)
setint32 (offset, value)
setint64 (offset, value)
setint8 (offset, value)
setnumber (offset, value)
setstring (offset, s)
setuint16 (offset, value)
setuint32 (offset, value)
setuint8 (offset, value)


Functions

__len ()

Returns:

    integer data size in bytes
__tostring ()

Returns:

    string
checksum ([offset[, length]])

Parameters:

  • offset integer (optional)
  • length integer (optional)

Returns:

    integer

Raises:

if out of bounds
getbyte (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getint16 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getint32 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getint64 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getint8 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getnumber (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getstring (offset[, length])

Parameters:

  • offset integer
  • length integer number of bytes; default: from offset to end (optional)

Returns:

    string

Raises:

if out of bounds
getuint16 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getuint32 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
getuint8 (offset)

Parameters:

  • offset integer

Returns:

    integer

Raises:

if out of bounds
new (size)

Parameters:

  • size integer

Returns:

    data

Raises:

if allocation fails
resize (new_size)

Parameters:

  • new_size integer

Raises:

if read-only or not owned
setbyte (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setint16 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setint32 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setint64 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setint8 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setnumber (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setstring (offset, s)

Parameters:

Raises:

if out of bounds or read-only
setuint16 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setuint32 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
setuint8 (offset, value)

Parameters:

  • offset integer
  • value integer

Raises:

if out of bounds or read-only
generated by LDoc 1.5.0 Last updated 2026-03-31 12:21:45