Skip to content
Topaz6.0 · Before release
Download

Search documentation

Specification 6.0 · Not released · Tested product 5.21.3

Use arrow keys to choose a result. Press Enter to open.

Type an API name, diagnostic number, rule, or project topic.

    Library

    std.toml

    Parse and serialize TOMLValue values and convert JSONValue input.

    APIs in this module

    4 APIs

    NameModule
    std.toml.fromJsonstd.toml
    std.toml.parsestd.toml
    std.toml.stringifystd.toml
    TOMLValue.toJsonstd.toml

    Module

    Link

    Parse TOML 1.0 documents into TOMLValue, write deterministic TOML, and convert JSON through explicit Result values. Date kinds and numeric precision follow the format conversion rules.

    Why

    Link

    Configuration data keeps TOML parsing separate from conversions that may lose representable information.

    Availability

    Link

    Import std.toml in language mode 5.21. The current compiler selects std/toml.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.

    Exported types

    Link

    export type TOMLValue = TOMLValue

    Type members keep the compiler-owned type name shown in their declarations. Importing a module does not create a new type identity.

    Public API

    Link

    std.toml.parse

    std.toml.stringify

    std.toml.fromJson

    TOMLValue.toJson

    Pending contracts

    Link

    Parse complete TOML 1.0 documents

    Link
    Ruletopaz.stdlib.contract.toml-parse.rule

    Parse complete TOML 1.0 documents

    parse accepts a complete TOML 1.0 document. An empty document or comments with whitespace produce an empty root table. Basic and literal strings, multiline strings, dotted and quoted keys, inline tables, arrays and arrays of tables retain their TOML meanings.

    Integers must fit the signed 64 bit range. TOML decimal, hexadecimal, octal and binary spellings and valid underscore separators are accepted. Floating values use IEEE binary64 rounding. The TOML inf and nan forms are valid TOML values. Finite overflow follows the TOML numeric error boundary and returns Err.

    Offset date times, local date times, local dates and local times remain distinct TOML kinds. Invalid calendar fields and time fields return Err. Strings that resemble dates remain strings.

    A key or table definition may not redefine an existing value under the TOML 1.0 rules. Names are compared after decoding. Malformed escapes, leading zeroes and misplaced underscore separators return Err without exposing a partial document.

    A failure returns a nonempty string identifying the cause, one based line and Unicode scalar column. CRLF is a single line break. The first offending scalar is the location and an incomplete input points immediately after its last scalar. Source comments and layout are not retained in TOMLValue.

    The text argument is evaluated once. Parsing consumes the complete document, performs no I/O and does not invoke JSON conversion. Syntax failures use Err rather than a runtime diagnostic.

    Why

    Configuration files need a named format version and predictable rejection of invalid definitions. Preserving TOML kinds lets callers choose a separate and explicit conversion into JSON.

    Source evidence

    Parse a table and write its deterministic form

    Link
    main.tpzParse a table and write its deterministic formOpen in Playground
    1. import std.toml
    2. import std.test
    3. import std.io
    4. let value = test.assertOk(toml.parse("title = \"Topaz\"\ncount = 6\nactive = true\n[page]\nwidth = 210\n"))
    5. io.writeLine(test.assertOk(toml.stringify(value)))
    6. let empty = test.assertOk(toml.parse(" # comment\n"))
    7. test.assertEq(test.assertOk(toml.stringify(empty)), "")
    Expected outputexit 0
    active = true
    count = 6
    title = "Topaz"
    
    [page]
    width = 210
    
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. active = true
    2. count = 6
    3. title = "Topaz"
    4. [page]
    5. width = 210
    Source evidence

    Accept literal strings, multiline values, radix integers and dates

    Link
    main.tpzAccept literal strings, multiline values, radix integers and datesOpen in Playground
    1. import std.toml
    2. import std.io
    3. for text in (["title = 'ink#paper'\n", "text = \"\"\"\nfirst\nsecond\"\"\"\n", "value = 0xff\n", "date = 1979-05-27T07:32:00Z\n", "value = inf\n", "value = nan\n"]) {
    4. match (toml.parse(text)) {
    5. case Ok(_) => io.writeLine("accepted")
    6. case Err(_) => io.writeLine("rejected")
    7. }
    8. }
    Expected outputexit 0
    accepted
    accepted
    accepted
    accepted
    accepted
    accepted
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. accepted
    2. accepted
    3. accepted
    4. accepted
    5. accepted
    6. accepted
    Source evidence

    Reject malformed numeric spellings and repeated definitions

    Link
    main.tpzReject malformed numeric spellings and repeated definitionsOpen in Playground
    1. import std.toml
    2. import std.io
    3. for text in (["n = 1__0\n", "n = 01\n", "[a]\nx = 1\n[a]\ny = 2\n", "x = 1\nx = 2\n"]) {
    4. match (toml.parse(text)) {
    5. case Ok(_) => io.writeLine("accepted")
    6. case Err(_) => io.writeLine("invalid")
    7. }
    8. }
    Expected outputexit 0
    invalid
    invalid
    invalid
    invalid
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. invalid
    2. invalid
    3. invalid
    4. invalid
    Source evidence

    Return line and scalar column in a TOML error

    Link
    main.tpzReturn line and scalar column in a TOML errorOpen in Playground
    1. import std.toml
    2. import std.test
    3. import std.io
    4. let error = test.assertErr(toml.parse("x = ?"))
    5. test.assertContains(error, "line 1")
    6. test.assertContains(error, "column 5")
    7. io.writeLine("located")
    Expected outputexit 0
    located
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. located
    Source evidence

    Write deterministic TOML documents

    Link
    Ruletopaz.stdlib.contract.toml-stringify.rule

    Write deterministic TOML documents

    stringify accepts a TOMLValue whose root is a table. A scalar or array root returns Err because it is not a TOML document. An empty table becomes empty text.

    Each table writes its scalar and array entries before child table sections. Both groups follow the decoded key order. Arrays retain element order. Table headers use the complete dotted path. A noninitial table section is separated by one blank line.

    Assignments use one space on either side of the equals sign. Inline arrays and tables use a comma followed by one space. Every nonempty document uses LF line endings and ends with one LF. Comments, indentation and source ordering are not reproduced.

    Bare keys use the TOML ASCII key alphabet. Other keys and string values use basic quoted strings with deterministic escaping. Integers use decimal digits without separators. Finite floats use the shortest binary64 roundtrip value and retain a decimal point or exponent to distinguish a float from an integer. Positive and negative zero are written as 0.0 and -0.0. Nonfinite values use inf, -inf or nan.

    Dates and times use their TOML kind, a capital T separator and a capital Z for a zero offset. Local kinds retain their lack of an offset. Fractional seconds omit redundant trailing zeroes.

    The value argument is evaluated once. Serialization performs no I/O, does not mutate the value and returns Err without partial output when the value cannot form a document. Parse the result with toml.parse to recover the same TOML kinds and values.

    Why

    A deterministic writer supports stable configuration diffs. Requiring a table root makes its successful output usable as a complete TOML document, and numeric normalization follows the stored numeric value.

    Source evidence

    Reject a scalar as a complete TOML document

    Link
    main.tpzReject a scalar as a complete TOML documentOpen in Playground
    1. import std.json
    2. import std.toml
    3. import std.test
    4. import std.io
    5. let tree = test.assertOk(json.parse("7"))
    6. let value = test.assertOk(toml.fromJson(tree))
    7. match (toml.stringify(value)) {
    8. case Ok(_) => io.writeLine("accepted")
    9. case Err(_) => io.writeLine("root table required")
    10. }
    Expected outputexit 0
    root table required
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. root table required
    Source evidence

    Write the binary64 value rather than its input spelling

    Link
    main.tpzWrite the binary64 value rather than its input spellingOpen in Playground
    1. import std.toml
    2. import std.test
    3. import std.io
    4. let value = test.assertOk(toml.parse("x = 0.10000000000000001\n"))
    5. io.writeLine(test.assertOk(toml.stringify(value)))
    Expected outputexit 0
    x = 0.1
    
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. x = 0.1
    Source evidence

    Convert TOML and JSON with explicit failures

    Link
    Ruletopaz.stdlib.contract.toml-json.rule

    Convert TOML and JSON with explicit failures

    fromJson recursively converts a JSONValue into a TOMLValue and returns Result<TOMLValue, string>. Booleans, strings, arrays and objects retain their values and structure. JSON null has no TOML representation and returns Err, including a nested null.

    An integer lexeme must fit signed 64 bit and becomes a TOML integer. An out of range integer returns Err rather than changing into a float. A fractional or exponent lexeme becomes binary64 with nearest ties to even rounding. Overflow to infinity returns Err. Finite rounding and underflow may change the exact decimal value.

    A string is kept as a string even when it resembles a date or time. Converting a JSON scalar or array is permitted, but writing it as a complete TOML document still requires a root table.

    TOMLValue.toJson() -> Result<JSONValue, string> recursively converts a TOML value. Tables become objects and arrays retain order. Finite numbers follow JSON numeric conversion. Nonfinite numbers return Err rather than becoming a string or null.

    TOML dates and times become strings in the normalized TOML spelling used by the writer. This conversion loses their TOML kind. JSON also does not distinguish an integer from an integral float. A reverse conversion therefore need not restore the original TOML kinds. Comments and source number spellings are not preserved.

    Both conversions visit array elements by index and object or table keys in the decoded key order. They stop at the first unrepresentable child. The nonempty error identifies its path rooted at $ and its cause. Inputs remain unchanged and neither conversion performs I/O.

    Why

    A format conversion must expose values that its destination cannot represent. A Result keeps nonfinite failure explicit and avoids inventing a second conversion function or silently changing a numeric value into another kind.

    Source evidence

    Reject null and out of range integer conversion

    Link
    main.tpzReject null and out of range integer conversionOpen in Playground
    1. import std.json
    2. import std.toml
    3. import std.test
    4. import std.io
    5. for text in (["null", "9223372036854775808", "1e9999"]) {
    6. let value = test.assertOk(json.parse(text))
    7. match (toml.fromJson(value)) {
    8. case Ok(_) => io.writeLine("accepted")
    9. case Err(_) => io.writeLine("unrepresentable")
    10. }
    11. }
    Expected outputexit 0
    unrepresentable
    unrepresentable
    unrepresentable
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. unrepresentable
    2. unrepresentable
    3. unrepresentable
    Source evidence

    Identify the first unrepresentable child

    Link
    main.tpzIdentify the first unrepresentable childOpen in Playground
    1. import std.json
    2. import std.toml
    3. import std.test
    4. import std.io
    5. let value = test.assertOk(json.parse("\{\"x\":[null]\}"))
    6. let error = test.assertErr(toml.fromJson(value))
    7. test.assertContains(error, "$.x[0]")
    8. io.writeLine("child located")
    Expected outputexit 0
    child located
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. child located
    Source evidence

    Convert a TOML table through a recoverable JSON result

    Link
    main.tpzConvert a TOML table through a recoverable JSON resultOpen in Playground
    1. import std.json
    2. import std.toml
    3. import std.test
    4. import std.io
    5. let value = test.assertOk(toml.parse("name = \"Topaz\"\ncount = 6\n"))
    6. let tree = test.assertOk(value.toJson())
    7. io.writeLine(test.assertOk(json.stringify(tree)))
    8. let restored = test.assertOk(toml.fromJson(tree))
    9. io.writeLine(test.assertOk(toml.stringify(restored)))
    Expected outputexit 0
    {"count":6,"name":"Topaz"}
    count = 6
    name = "Topaz"
    
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. {"count":6,"name":"Topaz"}
    2. count = 6
    3. name = "Topaz"
    Source evidence

    Return an error for a TOML infinity during JSON conversion

    Link
    main.tpzReturn an error for a TOML infinity during JSON conversionOpen in Playground
    1. import std.toml
    2. import std.test
    3. import std.io
    4. let value = test.assertOk(toml.parse("value = inf\n"))
    5. match (value.toJson()) {
    6. case Ok(_) => io.writeLine("accepted")
    7. case Err(_) => io.writeLine("nonfinite rejected")
    8. }
    Expected outputexit 0
    nonfinite rejected
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. nonfinite rejected
    Source evidence

    Menu

    Download