murex rocks

Welcome

About

Install

Change Log

Blog

Technical Docs

Language Tour

Interactive Shell

Rosetta Stone

User Guide

Open Source

Discuss

Contribute

Source Code

Search Site

toml

Tom’s Obvious, Minimal Language (TOML)

Description

TOML support within Murex is pretty mature however it is not considered a primitive. Which means, while it is a recommended builtin which you should expect in most deployments of Murex, it’s still an optional package and thus may not be present in some edge cases. This is because it relies on external source packages for the shell to compile.

Examples

Example TOML document taken from Wikipedia

# This is a TOML document.

title = "TOML Example"

[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00 # First class dates

[database]
server = "192.168.1.1"
ports = [ 8001, 8001, 8002 ]
connection_max = 5000
enabled = true

[servers]

  # Indentation (tabs and/or spaces) is allowed but not required
  [servers.alpha]
  ip = "10.0.0.1"
  dc = "eqdc10"

  [servers.beta]
  ip = "10.0.0.2"
  dc = "eqdc10"

[clients]
data = [ ["gamma", "delta"], [1, 2] ]

# Line breaks are OK when inside arrays
hosts = [
  "alpha",
  "omega"
]

Default Associations

• Extension: toml
• MIME: +toml
• MIME: application/toml
• MIME: application/x-toml
• MIME: text/toml
• MIME: text/x-toml

Supported Hooks

• Marshal() Supported
• ReadArray() Hook supported albeit TOML doesn’t support naked arrays
• ReadArrayWithType() Hook supported albeit TOML doesn’t support naked arrays
• ReadIndex() Works against all properties in TOML
• ReadNotIndex() Works against all properties in TOML
• Unmarshal() Supported

See Also

• Define Type: cast: Alters the data-type of the previous function without altering its output
• Get Nested Element: [[ Element ]]: Outputs an element from a nested structure
• Open File: open: Open a file with a preferred handler
• Reformat Data Type: format: Reformat one data-type into another data-type
• Shell Runtime: runtime: Returns runtime information on the internal state of Murex
• json: JavaScript Object Notation (JSON)
• jsonl: JSON Lines
• yaml: YAML Ain’t Markup Language (YAML)
• index: Outputs an element from an array, map or table

Read more about type hooks

• ReadIndex() (type): Data type handler for the index, [, builtin
• ReadNotIndex() (type): Data type handler for the bang-prefixed index, ![, builtin
• ReadArray() (type): Read from a data type one array element at a time
• WriteArray() (type): Write a data type, one array element at a time
• ReadMap() (type): Treat data type as a key/value structure and read its contents
• Marshal() (type): Converts structured memory into a structured file format (eg for stdio)
• Unmarshal() (type): Converts a structured file format into structured memory

---

This document was generated from builtins/types/toml/toml_doc.yaml.