{"route":"/en-US-v0.14.1/reference/data-loading/toml/","title":"TOML","description":"Documentation for the `toml` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"conversion","name":"Conversion","children":[{"id":"notes","name":"Notes","children":[]}]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-source","name":"source","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-decode","name":"Decode TOML","children":[{"id":"definitions-decode-data","name":"data","children":[]}]},{"id":"definitions-encode","name":"Encode TOML","children":[{"id":"definitions-encode-value","name":"value","children":[]},{"id":"definitions-encode-pretty","name":"pretty","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"toml","title":"TOML","keywords":[],"oneliner":"Reads structured data from a TOML file.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Reads structured data from a TOML file.

\n

The file must contain a valid TOML table. The TOML values will be converted\ninto corresponding Typst values as listed in the table below.

\n

The function returns a dictionary representing the TOML table.

\n

The TOML file in the example consists of a table with the keys title,\nversion, and authors.

\n

Example

\n
#let details = toml("details.toml")\n\nTitle: #details.title \\\nVersion: #details.version \\\nAuthors: #(details.authors\n  .join(", ", last: " and "))\n
\"Preview\"
\n

Conversion details

\n

First of all, TOML documents are tables. Other values must be put in a table\nto be encoded or decoded.

\n\n\n\n\n\n\n\n\n
TOML valueConverted into Typst
stringstr
integerint
floatfloat
booleanbool
datetimedatetime
arrayarray
tabledictionary
\n\n\n\n\n\n\n\n
Typst valueConverted into TOML
types that can be converted from TOMLcorresponding TOML value
noneignored
bytesstring via repr
symbolstring
contenta table describing the content
other types (length, etc.)string via repr
\n

Notes

\n"}],"self":false,"params":[{"name":"source","details":[{"kind":"html","content":"

A path to a TOML file or raw TOML bytes.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["dictionary"],"scope":[{"path":["toml"],"name":"decode","title":"Decode TOML","keywords":[],"oneliner":"Reads structured data from a TOML string/bytes.","element":false,"contextual":false,"deprecationMessage":"`toml.decode` is deprecated, directly pass bytes to `toml` instead","deprecationUntil":"0.15.0","details":[{"kind":"html","content":"

Reads structured data from a TOML string/bytes.

"}],"self":false,"params":[{"name":"data","details":[{"kind":"html","content":"

TOML data.

"}],"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["dictionary"],"scope":[]},{"path":["toml"],"name":"encode","title":"Encode TOML","keywords":[],"oneliner":"Encodes structured data into a TOML string.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Encodes structured data into a TOML string.

"}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

Value to be encoded.

\n

TOML documents are tables. Therefore, only dictionaries are suitable.

"}],"types":["dictionary"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"pretty","details":[{"kind":"html","content":"

Whether to pretty-print the resulting TOML.

"}],"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]}]}}}