Упаковка данных [Lua 5.3]

При имплементации интернет-протоколов часто требуется упаковать значения в определённом формате. Например, представить число 0x123456 в виде 32-битного целого числа в формате Big-endian (и получить строку "\0\x12\x34\x56").

Для этих целей Lua 5.3 имеет функции string.pack, string.unpack и string.packsize. Все они требуют строку формата.

Строка формата — это последовательный набор символов, которые определяют, как будут конвертироваться значения.

Пробелы в строке формата игнорируются.

Скармливать её можно в три функции:

• string.pack(formatString: string, args...) — спакует значения в строку по формату.
• string.unpack(formatString: string, args...) — распакует значения из строки по формату.
• string.packsize(formatString: string) — вернёт размер строки, получаемой из string.pack с данной строкой формата. Последняя не должна содержать опции s или z.

Примеры

-- Для удобства определим функцию `hex`.
local function hex(s)
  return s:gsub(".", function(c)
    return ("%02x "):format(c:byte())
  end):sub(1, -2)
end

print(hex(string.pack("> s3 I4 n", "hello", 0x12345678, math.pi)))
--> 00 00 05 68 65 6c 6c 6f 12 34 56 78 40 09 21 fb 54 44 2d 18
--[[\______/ \____________/ \_________/ \_____________________/
     длина   строка "hello"      I4      число 3.1415926535898
    \_____________________/                    lua_Number
              s3
  ]]

print(string.unpack(
  "> s3 I4 n",
  "\0\0\5\x68\x65\x6c\x6c\x6f\x12\x34\x56\x78\x40\9\x21\xfb\x54\x44\x2d\x18"
))
--> hello   305419896       3.1415926535898

-- (на разных машинах может отличаться)
print(string.packsize("> I4 n f T"))
--> 24

Подробнее

• Format Strings for Pack and Unpack: Lua 5.3 Reference Manual, lua.org