-
v2.0.0
Stablereleased this
2026-09-22 19:52:42 +00:00 | 0 commits to main since this releaseAdded
encoding.TextMarshalerandencoding.TextUnmarshalerare honoured by
default, with no option to switch them off. A type that implements them is
encoded as a TOML string and decoded from one:net.IPbecomes
"192.0.2.1", and a user type withMarshalTextorUnmarshalTextfollows.
MarshalTOMLandUnmarshalTOMLstill win over the text methods, and the
four date-time types keep their bare timestamp form instead of becoming a
quoted string. A struct type that implements the interface now encodes as a
string where it was a table before, which is the breaking part of the change.time.Durationis encoded in its canonical Go form as a TOML string,
1h30m0s, because TOML has no duration type; the decoder reads that string
back and still accepts a bare integer as the nanosecond count.interpres-decode --encode, the adapter's other direction: it reads the
toml-test tagged JSON from stdin and writes the TOML document it describes.
The compliance suite now runs the encoder as well as the decoder, 214
encoder cases against the tagged JSON of the valid corpus.InlineTables(threshold): a sub-table whose single-line rendering is
at mostthresholdbytes is written as an inline table instead of a header
section, which shortens a document of small tables. An array of tables keeps
its header form, because its inline form would re-parse as a value array.DocumentandParseMap:Parsenow returns a*Document, which holds the
values together with the key order, whether a table was written as an inline
table or under a header, and the comments, withKeys,Entries,Get,
CommentsandSetCommentsto read and write them.ParseMapreturns the
plainmap[string]anytree, the shapeParseused to give.- The edit pipeline on a
Document: typed getters onDocumentandTable
(GetString,GetInt,GetFloat,GetBool,GetArray,GetTable),
SetandDeletethat keep the surviving keys' positions and comments,
UnmarshalDocument, which decodes the document into a typed destination
without parsing again, andMarshalof aDocument, which writes the keys
in written order, the comments above the lines and headers they belonged
to, and the inline tables inline. OffsetDateTime, the Go type of the offset date-time kind, so that all four
TOML date-time kinds have one of their own.ParseandUnmarshalhand it
back where they produced a baretime.Timebefore, andMarshalaccepts it.
Unmarshalling into a struct field of typetime.Timekeeps working, because
the plain type takes an offset date-time as it always did; code that asserts
the tree's type, andUnmarshalTOMLimplementations that expect a
time.Time, need the new type.MaxNestingDepth(depth)andMaxInputSize(size)options bound the parse an
Unmarshalperforms, and every parse carries a nesting limit in any case
(10000 levels, which no hand-written document approaches): a document that
nests arrays or inline tables deeper used to run the stack out and is now
rejected with aSyntaxErrornaming the limit.Statements(r), an iterator over the top-level statements of the document
the reader carries, in written order: key/value statements, a[table]
header as one statement with its node, an[[array of tables]]as one
statement per element. A caller that breaks after the statement it wanted
reads no further ones.examples/statementsshows the walk.ParseAs[T](data, opts...), the generic one-line decode, andNewSchema[T](),
which precompiles the struct schema and the interface flags for a hot path
before the first document arrives.EmitFieldComments(true)prints the comment a field'stomltag
carries in acomment=option above the field's line or header, the
comments a round trip through the Go type would otherwise drop. Go doc
comments are not visible to reflection, so the tag is the channel that
carries the text.LocalTimeLocation(loc)lets a local date-time fill a plain
time.Timedestination in the location given, relabelled rather than
shifted:07:32in the document is07:32in the zone. Without the
option the wrapper types remain the only destinations a local kind fills.- The parse checks its context inside a value as well as between statements:
an array, an inline table and a multi-line string check every 64 elements
or lines, so one huge value cannot hold the parse past its cancellation. OrderedMap, the string-keyed table that remembers the order its keys were
set in: decoding into one fills it in the order the document wrote the
keys, andMarshalwrites one back in that order, where a map carries no
order on decode and sorts on encode. It works as a decode target on its
own, in a struct field, and as the element of an array of tables; its
values are untyped, so a nested table stays amap[string]any.Unmarshal(data, v, opts...)and the other entries take variadic options,
the shape encoding/json/v2 uses:RejectUnknownFields,
NumbersAsLiterals,MaxNestingDepth,MaxInputSize,
LocalTimeLocation.MarshalWrite(w, v, opts...)and
UnmarshalRead(r, v, opts...)are the streaming forms.Marshalcarries a nesting limit of 10000 levels, the parser's own figure:
cyclic data, which used to run the stack out, is now rejected with an error
that names the limit and the path it was met at.- The
tomltag gained therequiredoption: a field tagged
toml:"host,required"makes the decode fail with
missing required key "host"when the document carries no key that
resolves to it. The option shapes decoding only, and the encoder ignores
it. UnmarshalerContext, the custom-decode interface that hands the decode's
context to the method,UnmarshalTOMLContext(ctx, data). It wins over
UnmarshalTOMLwhen a type implements both, so a long custom decode can
abort on cancellation; a non-cancellable entry point hands in
context.Background, never nil.- A TOML array decodes into a Go fixed-size array,
[N]T, where only a slice
was accepted before; the encoder could already encode one. A length mismatch
is an error wrapped with the key path. MarshalAppend(buf, v)appends the TOML encoding of v to buf and returns
the extended buffer, the shapejson.MarshalAppendhas.interpres-decode --versionprints the binary's version, the module version
the toolchain recorded, so a release-built binary names its own tag.interpres-decode --jsonprints plain indented JSON instead of the tagged
form, the shape for people and diffs, with the date-time wrappers in their
TOML form.interpres-decode --validatewalks a named directory for.tomlfiles and
closes the sweep with a summary naming how many documents were checked and
how many were invalid; single files stay quiet on success as before.interpres-decode --structinfers a Go struct definition from a document:
one field per key in written order, nested tables as nested struct types,
an array of tables as a slice. The printed type compiles and decodes the
document it came from.interpres-decode --schema TYPE file.gowrites a TOML template for the
named struct type of a Go source, thecomment=tag option printed as a
comment and thedefault=option as the value. It is the inverse of
--struct.ParseFile(path)reads the file and parses it into aDocument, with the
file name at the front of every error it returns, read failure and parse
failure alike.Valid(data)reports whether a document parses, nil on
success and the parse error on failure, the library call the--validate
mode of interpres-decode is built on.SyntaxErrorcarries the byteOffsetthe scan stopped at and the 1-based
Columnon the line, beside the line it always had, andSourceLine(src)
renders that line with a caret under the position, for messages shown under
the input. An input that is not valid UTF-8 names the offset of the first
invalid byte in its message. The new fields are additive: aSyntaxError
built from a line and a message alone is unchanged.NumbersAsLiterals(true)decodes the integers and floats of the document into
Number, which carries the literal the document wrote, so0x1f,1_000,
+1.0andinfsurvive a round trip with their spelling instead of the
normalised31,1000and1.0. Typed destinations take the evaluated
value as before, aNumberfield takes the literal, andMarshalwrites a
Numberback as its bare literal, rejecting one that is not a valid TOML
number.
Changed
- The stateful
DecoderandEncoderof 1.x are replaced by variadic
options on the entries, the shape encoding/json/v2 uses:Layout(kind)
withLayoutKindGroupedorLayoutKindDeclaration,OmitEmptyArrays,
LiteralMultiline(threshold),InlineTables(threshold),
EmitFieldComments,RejectUnknownFields,NumbersAsLiterals,
MaxNestingDepth,MaxInputSize,LocalTimeLocation. DecodeErrorandEncodeErrorcarry onePathtype, a list of segments
("items","[0]","weight") with aString()rendering the TOML
notation,items[0].weight. The decode error used to hold a bare
[]string, the encode error a plain string. Both messages render the same
way now,interpres: items[0].weight: ..., with oneinterpres:prefix
where the composition used to double it.omitemptyfollows the encoding/json semantics: the field is skipped when
it holds an empty string, a zero number,false, a nil pointer or
interface, or a nil or empty slice, array or map. In 1.x the option covered
only the collections.- The
tomltag gained theinlineoption: a struct or map field tagged
toml:"retry,inline"emits asretry = {â¦}instead of a header section,
whatever its size, a named embedded struct included. Forcing it on an array
of tables is an error, because the inline form would re-parse as a value
array and change the value's Go type. - The output takes the TOML 1.1 form. A date-time writes its seconds only when
the value carries them and drops the trailing zeros of a fractional second,
so07:32:00is written07:32and half a second as00.5. Both are the
same value, and a document written without seconds now comes back without
them.LocalDateTime.String(),LocalTime.String()and the offset date-time
rendering follow the same rule. - An inline table that would pass the hundredth column is written across lines
with a trailing comma and one tab of indentation per nesting level, the shape
TOML 1.1 allows an inline table to take. MarshalTOMLreaches every array element and every field, whatever the Go
kind, and its result is normalised like any other value: an element rendering
itself as a table keeps the[[header]]form, one rendering itself as a
scalar turns the array into a value array, and the method runs once per
element. It is found on the addressable pointer as well, so a
pointer-receiverMarshalTOMLis called for a field or an element, exactly
asMarshalTextis.- TOML 1.1 is the acceptance contract, and TOML 1.0 is not. The compliance
suite runs the 1.1 corpus alone, and the promise that every 1.0 document
parses exactly as before is withdrawn. Nothing that parses today stops
parsing: the 1.0 valid corpus still passes in full. The documents whose
verdict changes are the ones 1.1 relaxed, such as the\xHHescape
sequences 1.0 rejected. - The module path carries the /v2 suffix the Go toolchain requires of
every major version 2 module: imports change to
sourcedock.dev/petrbalvin/interpres/v2. - Input that is not valid UTF-8 is now rejected where the parser's scan
meets the invalid byte, with aSyntaxErrornaming that line, instead of
a whole-input check that always reported line 1. Invalid input is still
rejected; the reported location is now the byte's own.
Performance - Struct destinations decode directly: for a type the direct skeleton can
model, the parser resolves tables and keys against the struct schema while
the document scans and no intermediate value tree is kept. The strict
decode of the representative document drops from 168 to 160 allocations
per call against the tree path in the same process, and the 2000-element
document reaches allocation parity; every document the skeleton cannot
model falls back to the tree path and its exact error contracts. A
differential fuzz target decodes every generated document both ways. - Marshal writes plain scalars and typed scalar arrays straight from their
reflect cells instead of boxing them into interface values first, and skips
the per-element resolution for arrays that can never take the[[header]]
form. The representative document now costs 130 allocations per call
instead of 141, the long array-of-tables document 55 915 instead of
63 660, with byte-identical output. - Parsing is faster than in 1.1.0 while carrying the new document layer:
the suite's representative document decodes at about 79 MB/s with 104
allocations per call, and the long array-of-tables document at about
106 MB/s against 56 MB/s in 1.1.0, with allocations on that document
halved from 67 664 to 31 765. Date-time tokens are validated by a byte
scan instead of regular expressions, repeated keys share one string
across array-of-tables elements, and per-statement buffers are reused. - Typed decoding is 12 percent faster than in 1.1.0 on the representative
document (9792 ns against 11 147 ns) with 24 percent fewer allocations
(167 against 220); interface lookups resolve through a cached per-type
flag set instead of boxing every value into an interface to ask. Marshalruns at the 1.1.0 speed while emitting the new TOML 1.1 output
form, at half the bytes per operation (6170 against 11 348 on the
representative document), and writes through a pooled output buffer with
a 1 MiB retention cap; repeated marshals keep the live heap flat.- Two benchmarks measure the shapes that drove the work:
BenchmarkStrictDecodeLongandBenchmarkMarshalLongrun the 2000-entry
document at about 3.8 ms and 3.4 ms per call, at 63 772 and 63 660
allocations.
Fixed
- An offset date-time written with the
+00:00offset kept the anonymous
locationtime.Parseinvents for it, so a round trip through the tree and
Marshal, which writes a zero offset asZ, changed the value's
reflection-visible location. The zero offset normalises totime.UTCat
parse, and the tree is stable across the round trip. - Decoding into a defined type whose underlying kind is string or bool, such
astype Name string, panicked instead of storing the value, because a
value of the predeclared type is not assignable to a defined type and the
decoder assigned it without a conversion. - A top-level value the encoder could not normalise reported its path with
a leading dot,interpres: .port: ...; the message now reads
interpres: port: ..., the shapeEncodeError.Pathalready used. - A token shaped like a date-time with a component out of range, such as an
hour of 24 or a February the 30th, fell through to the number decoder and
failed with the number complaintinvalid character "-" in number; it now
fails as the date-time it visibly is,invalid date-time "...". - A
time.TimeorOffsetDateTimewhose zone offset is not a whole number
of minutes wrote only the minutes, silently shifting the instant by the
seconds dropped; the encoder now refuses such an offset, which TOML has no
form for, instead of corrupting the value. - An empty array of tables over pointer elements,
[]*T{}, emitted as
key = []while its value form was omitted; it is omitted too now, the
rule TOML forces, because an empty[[a]]has no valid form. - Two lenient grammar edges are closed: a sign in a
\uor\Uescape,
which is not a hex digit, is rejected instead of evaluating, and a bare
carriage return right after a multi-line string's opening delimiter is
the bare-CR error instead of a newline trimmed silently.
Migration from 1.x
The module path. 2.0 lives at
sourcedock.dev/petrbalvin/interpres/v2,
the suffix the Go toolchain requires of every major version 2 module. Change
every import andgo getline:go get sourcedock.dev/petrbalvin/interpres/v2TOML 1.1 only. The acceptance contract is the TOML 1.1 corpus, and the
promise that every 1.0 document parses exactly as before is withdrawn.
Documents whose verdict changes are the ones 1.1 relaxed:\eand\xHH
escapes, times without seconds, multi-line inline tables with comments and a
trailing comma. Nothing that parsed in 1.x stops parsing, because the 1.1
grammar contains the 1.0 one.
The output takes the 1.1 form. A date-time writes seconds only when the
value carries them, a fraction drops its trailing zeros, and a long inline
table breaks across lines. A document written from the same value can come
out shorter; it re-parses to the same value.
Text methods on by default. A type implementing
encoding.TextMarshalerorencoding.TextUnmarshalernow takes the text
path with no option to switch it off. A struct that implemented the
interface encodes as a string where it was a table before.MarshalTOMLand
UnmarshalTOMLstill win.
One Go type per date-time kind. Offset date-times hand back
OffsetDateTime, not a baretime.Time. Code that type-asserts the tree or
expectstime.TimeinsideUnmarshalTOMLneeds the new wrapper; a
destination field of typetime.Timekeeps working.
The document carries what the map could not.Parsereturns a
*Documentwith the key order, the inline distinction and the comments;
ParseMapgives the plainmap[string]anytree the oldParsereturned.
The document is writable, andMarshalwrites it back with its comments.
Options instead of Decoder and Encoder. The stateful types of 1.x are
gone; the entries take variadic options, the shape encoding/json/v2 uses.
NewDecoder().DisallowUnknownFields().Decode(data, &cfg)becomes
Unmarshal(data, &cfg, RejectUnknownFields(true)), and the encoder
methods become options:Layout(LayoutKindDeclaration)replaces
GroupByKind(false),LiteralMultilinereplacesUseLiteralMultiline.
Tag options.omitemptyfollows encoding/json: it now also drops empty
strings, zero numbers,false, nil pointers and nil interfaces.required
demands a key at decode.inlineforces the inline table form at encode.
comment=textcarries a commentEmitFieldCommentsprints.
Errors.DecodeError.Pathis aPath(segments with aString()
renderer),EncodeError.Paththe same type instead of a plain string, and
both messages renderinterpres: server.ports[2]: ...with one prefix.
SyntaxErrorgainedOffset,ColumnandSourceLine. Decode errors into
aNumber-carrying tree and the fixed-size array decode are new shapes a
match on the old messages would not see.
Decoding shapes.map[string]anyvalues merge into a non-empty map
destination; untagged embedded maps beyond the first stay empty; numbers can
stay literals underNumbersAsLiterals; local date-times can decode into
time.TimeunderLocalTimeLocation. All three are opt-in or additive
except where noted above.Downloads
-
v1.1.0
Stablereleased this
2026-09-17 23:12:03 +00:00 | 61 commits to main since this releaseAdded
- TOML 1.1 support, on by default: date-times and times without seconds
(07:32,1979-05-27T07:32, normalised to full seconds on output), the
\eand\xHHescape sequences, and multi-line inline tables with
comments and trailing commas. The compliance suite runs in TOML 1.1 mode:
214 valid and 467 invalid cases, zero failures. Every TOML 1.0 document
parses exactly as before. interpres-decode -validate [file ...]: a validate mode beside the
toml-test adapter. It parses each named file, or stdin when none are named,
prints one line per invalid document to stderr, and exits 0 when all are
valid, 1 when one is not, and 2 on a usage or read failure. Install it with
go install .../cmd/interpres-decode@latest; releases still ship no
binaries.DecodeErrorandEncodeError: decode and encode failures are wrapped in
typed errors carrying the key path, read witherrors.AsTypeinstead of
parsing the message text. The rendered messages keep their shape; the only
visible change is that an encode failure on a top-level field no longer
gains a meaningless leading dot in its path.omitzeroandomitemptytag options on encode:toml:"name,omitzero"
skips a field whose value is the zero value of its type (a type with an
IsZero() boolmethod decides through the method), and
toml:"name,omitempty"skips a nil or empty slice, array, or map. The
decoder ignores both options.
Changed
- The compliance suite is toml-test
v2.2.0, up from v1.6.0. Its TOML 1.0 corpus holds 205 valid and 474 invalid
cases (185 and 371 before), and it caught the two documents the parser
still accepted, fixed below. - The flattened struct layout the decoder consults is cached per struct type
and shared with the encoder, which now resolves duplicate field keys with
it. Strict decoding of an array of tables of structs runs about a quarter
faster; marshalling structs gained the same layout without measurable cost. - The parser scans the input bytes in place instead of building a
[]rune
copy of the document: every character that drives the grammar is ASCII and
the input is validated UTF-8 up front, so the conversion pass and its four
bytes per rune were pure overhead. Parsing a large array-of-tables document
runs about a fifth faster and allocates about half the memory. - Numeric tokens without underscores skip the normalising rebuild: digits are
validated in place injoinDigits, and a float whose token is already
clean goes tostrconv.ParseFloatdirectly. One allocation per integer
atom and two per float atom disappear.
Fixed
- A
MarshalTOMLresult ofnilwith a nil error fails the marshal with
MarshalTOML returned a nil value. The field silently vanished before, and
inside a value array the nil result reached reflection as a zero value and
panicked. - Strict decoding reports the smallest unknown key. Several unknown keys in
one table made the message depend on Go's random map iteration order, so
the same document reported different keys across runs. - Decoding into a struct that embeds a pointer to itself terminates. The
schema walk recursed through the embedded type forever, so such a
Unmarshalcall hung the process; the walk now tracks the struct types on
the current path and stops when one repeats. - An array-of-tables header whose path runs through an inline table
(a = {b = {}}followed by[[a.b.c]]) is rejected. The frozen-inline-table
check covered[table]headers and dotted keys but not the intermediate
steps of an array-of-tables header, so such a document silently extended the
inline table. - A new element of an array of tables starts a fresh scope for dotted-key paths
and nested arrays of tables:[[a]],b.c = 1,[[a]],[a.b]parses, as
the TOML examples in the spec shape it. The records of the previous element
falsely rejected the same paths in the next one. Marshalemits exactly one key when two struct fields resolve to the same
TOML name, picking the field the decoder would fill (the shallower one, the
later declaration at equal depth). Such a struct previously marshalled into
a duplicate key, and the output never re-parsed, breaking the round-trip
guarantee.Marshalreturns an error for a table header key or an inline-table key that
is not valid UTF-8, the way scalar keys already did, instead of silently
emitting corrupt TOML (a header that lost its key, an inline table with a
missing key).UseLiteralMultilinefalls back to the escaped basic string when the value
cannot be carried verbatim by the literal form: a run of three single quotes,
a control character, or a lone carriage return. Such values previously
produced output that did not re-parse.- A
[]anyholding only tables marshals in the value-array form with inline
tables, keeping the typeParseproduces for such an array. It previously
took the[[header]]form, so a round-trip changed the value's type from
[]anyto[]map[string]any. - Decoding into a
uintdestination checks the type's platform width instead
of only the fixed widths, so a 32-bituintno longer truncates silently;
decoding a finite float beyond thefloat32range is an overflow error
instead of a silent infinity. - Struct fields that resolve to one key at equal depth decode through the
field declared later, matching the documented rule; the first one won before. - A float with an exponent marker but no digits (
1e,0.0E) is rejected;
the exponent requires at least one digit. - A date-time offset outside 00:00 through 23:59 is rejected; such offsets
were accepted and silently rolled over (+00:60decoded as+01:00). - Untagged embedded fields now decode symmetrically with encode: an embedded
struct receives its keys inline (a nil embedded pointer struct is
allocated), an embedded map catches the keys no field claims, and a name
clash resolves in favour of the shallower field. A struct with an untagged
embedded field previously decoded with all inline keys dropped and did not
round-trip. Marshalre-emits arrays that mix tables with scalars: the table elements
render as inline tables inside the value array. A tree thatParseaccepts
from such a document previously failed with
cannot encode map[string]interface {}.
Downloads
- TOML 1.1 support, on by default: date-times and times without seconds
-
v1.0.0
Stablereleased this
2026-08-20 06:35:00 +00:00 | 102 commits to main since this releaseFirst stable release: a dependency-free TOML 1.0 parser and encoder for Go that
uses only the standard library and passes the entire
toml-test suite
(185 valid and 371 invalid cases, 0 failures).Added
Parsing
Parse(data []byte) (map[string]any, error): decode a TOML document into an
untyped tree.- Full TOML 1.0 syntax: comments; bare, quoted, and dotted keys; tables
([a.b]) and arrays of tables ([[a]]); basic and literal strings, including
multiline ("""/''') with escape sequences and line-ending backslash
trimming; integers in decimal, hex (0x), octal (0o), and binary (0b)
with_separators; floats with exponents andinf/nan; booleans;
offset/local date-times, dates, and times; arrays; and inline tables. - Distinct date-time types: offset date-times decode to
time.Time, while
LocalDateTime,LocalDate, andLocalTimerepresent the local variants,
each with aString()method returning the TOML-canonical rendering. - Strict, spec-conformant validation that rejects invalid documents: leading
zeros, misplaced underscores, malformed floats and radix literals, control
characters in strings and comments, bare carriage returns, non-UTF-8 input,
out-of-range Unicode escapes, multiline strings used as keys, single-digit
date-time components, duplicate/overwriting inline-table keys, and the full
family of table redefinitions (header vs. header, header vs. dotted key,
array of tables vs. table, and dotted-key appends to defined tables). SyntaxErrorcarrying the 1-based line of a malformed document.
DecodingUnmarshal(data []byte, v any): parse and map onto a struct or
map[string]anyvia reflection, with overflow-checked numeric conversion,
nested structs, slices, andmap[string]T.toml:"name"field tags, case-insensitive name fallback, andtoml:"-"to
skip a field.DecoderwithDisallowUnknownFieldsfor strict decoding that rejects keys
without a destination field, at every struct depth.Unmarshalerinterface (UnmarshalTOML(data any) error) for types that take
full control of their decode.
EncodingMarshal(v any) ([]byte, error): encode a struct ormap[string]Vvalue to
a TOML 1.0 document that re-parses to an equivalent value tree.Encoderwith chainable policy options:GroupByKind(group-by-kind layout
versus declaration order),OmitEmptyArrays, andUseLiteralMultiline.Marshalerinterface (MarshalTOML() (any, error)) for types that need a
custom TOML shape; the returned value is encoded normally.
CancellationParseContext,UnmarshalContext,MarshalContext,
(*Decoder).DecodeContextand(*Encoder).MarshalContexthonour a
context.Context, checked up front and every 64 statements or fields.
Project- Standard library only: zero third-party modules.
cmd/interpres-decode, a toml-test harness adapter (TOML on stdin, tagged
JSON on stdout).- A runnable example, a table-driven Go test suite, and a canonical
just
recipe set whosegatesrecipe is the definition of done. - Hand-written CI pipelines for the test, race and release gates.
SECURITY.mdfor private vulnerability reports.
Downloads