TOML Encoding

The toml module encodes Lua tables and decodes TOML documents.

Loading

local toml = require("toml")

Add toml to the executable entry's modules: list.

Encoding

toml.encode(data) accepts a table with string keys at the document root and returns string, error:

local encoded, err = toml.encode({name = "worker", enabled = true})
if err then return nil, err end

Nested tables and arrays are supported. Output is limited to 512 KiB. Comments and source key order are not preserved, and there are no formatting options.

Decoding

toml.decode(data) accepts a nonempty string of at most 256 KiB and returns table, error:

local config, err = toml.decode("name = 'worker'\nenabled = true")
if err then return nil, err end
print(config.name) -- "worker"

Tables become Lua tables with string keys; arrays use integer keys starting at 1. Integers, floats, booleans, and strings retain their corresponding Lua types. TOML dates and times become strings. Encoding those strings again produces quoted TOML strings, so date/time types do not survive a round trip.

Errors

See Error Handling for working with errors.