func Marshal(v interface{}) ([]byte, error)
Marshal serializes a Go value as a TOML document.
It is a shortcut for Encoder.Encode() with the default options.
▹ Example
▹ Example (Commented)
func Unmarshal(data []byte, v interface{}) error
Unmarshal deserializes a TOML document into a Go value.
It is a shortcut for Decoder.Decode() with the default options.
▹ Example
▹ Example (TextUnmarshal)
DecodeError represents an error encountered during the parsing or decoding of a TOML document.
In addition to the error message, it contains the position in the document where it happened, as well as a human-readable representation that shows where the error occurred in the document.
type DecodeError struct {
// contains filtered or unexported fields
}
▹ Example
func (e *DecodeError) Error() string
Error returns the error message contained in the DecodeError.
func (e *DecodeError) Key() Key
Key that was being processed when the error occurred. The key is present only if this DecodeError is part of a StrictMissingError.
func (e *DecodeError) Position() (row int, column int)
Position returns the (line, column) pair indicating where the error occurred in the document. Positions are 1-indexed.
func (e *DecodeError) String() string
String returns the human-readable contextualized error. This string is multi-line.
Decoder reads and decode a TOML document from an input stream.
type Decoder struct {
// contains filtered or unexported fields
}
func NewDecoder(r io.Reader) *Decoder
NewDecoder creates a new Decoder that will read from r.
func (d *Decoder) Decode(v interface{}) error
Decode the whole content of r into v.
By default, values in the document that don't exist in the target Go value are ignored. See Decoder.DisallowUnknownFields() to change this behavior.
When a TOML local date, time, or date-time is decoded into a time.Time, its value is represented in time.Local timezone. Otherwise the appropriate Local* structure is used. For time values, precision up to the nanosecond is supported by truncating extra digits.
Empty tables decoded in an interface{} create an empty initialized map[string]interface{}.
Types implementing the encoding.TextUnmarshaler interface are decoded from a TOML string.
When decoding a number, go-toml will return an error if the number is out of bounds for the target type (which includes negative numbers when decoding into an unsigned int).
If an error occurs while decoding the content of the document, this function returns a toml.DecodeError, providing context about the issue. When using strict mode and a field is missing, a `toml.StrictMissingError` is returned. In any other case, this function returns a standard Go error.
List of supported TOML types and their associated accepted Go types:
String -> string Integer -> uint*, int*, depending on size Float -> float*, depending on size Boolean -> bool Offset Date-Time -> time.Time Local Date-time -> LocalDateTime, time.Time Local Date -> LocalDate, time.Time Local Time -> LocalTime, time.Time Array -> slice and array, depending on elements types Table -> map and struct Inline Table -> same as Table Array of Tables -> same as Array and Table
func (d *Decoder) DisallowUnknownFields() *Decoder
DisallowUnknownFields causes the Decoder to return an error when the destination is a struct and the input contains a key that does not match a non-ignored field.
In that case, the Decoder returns a StrictMissingError that can be used to retrieve the individual errors as well as generate a human readable description of the missing fields.
▹ Example
Encoder writes a TOML document to an output stream.
type Encoder struct {
// contains filtered or unexported fields
}
func NewEncoder(w io.Writer) *Encoder
NewEncoder returns a new Encoder that writes to w.
func (enc *Encoder) Encode(v interface{}) error
Encode writes a TOML representation of v to the stream.
If v cannot be represented to TOML it returns an error.
A top level slice containing only maps or structs is encoded as [[table array]].
All slices not matching rule 1 are encoded as [array]. As a result, any map or struct they contain is encoded as an {inline table}.
Nil interfaces and nil pointers are not supported.
Keys in key-values always have one part.
Intermediate tables are always printed.
By default, strings are encoded as literal string, unless they contain either a newline character or a single quote. In that case they are emitted as quoted strings.
Unsigned integers larger than math.MaxInt64 cannot be encoded. Doing so results in an error. This rule exists because the TOML specification only requires parsers to support at least the 64 bits integer range. Allowing larger numbers would create non-standard TOML documents, which may not be readable (at best) by other implementations. To encode such numbers, a solution is a custom type that implements encoding.TextMarshaler.
When encoding structs, fields are encoded in order of definition, with their exact name.
Tables and array tables are separated by empty lines. However, consecutive subtables definitions are not. For example:
[top1] [top2] [top2.child1] [[array]] [[array]] [array.child2]
The encoding of each public struct field can be customized by the format string in the "toml" key of the struct field's tag. This follows encoding/json's convention. The format string starts with the name of the field, optionally followed by a comma-separated list of options. The name may be empty in order to provide options without overriding the default name.
The "multiline" option emits strings as quoted multi-line TOML strings. It has no effect on fields that would not be encoded as strings.
The "inline" option turns fields that would be emitted as tables into inline tables instead. It has no effect on other fields.
The "omitempty" option prevents empty values or groups from being emitted.
The "commented" option prefixes the value and all its children with a comment symbol.
In addition to the "toml" tag struct tag, a "comment" tag can be used to emit a TOML comment before the value being annotated. Comments are ignored inside inline tables. For array tables, the comment is only present before the first element of the array.
func (enc *Encoder) SetArraysMultiline(multiline bool) *Encoder
SetArraysMultiline forces the encoder to emit all arrays with one element per line.
This behavior can be controlled on an individual struct field basis with the multiline tag:
MyField `multiline:"true"`
func (enc *Encoder) SetIndentSymbol(s string) *Encoder
SetIndentSymbol defines the string that should be used for indentation. The provided string is repeated for each indentation level. Defaults to two spaces.
func (enc *Encoder) SetIndentTables(indent bool) *Encoder
SetIndentTables forces the encoder to intent tables and array tables.
func (enc *Encoder) SetTablesInline(inline bool) *Encoder
SetTablesInline forces the encoder to emit all tables inline.
This behavior can be controlled on an individual struct field basis with the inline tag:
MyField `toml:",inline"`
type Key []string
LocalDate represents a calendar day in no specific timezone.
type LocalDate struct {
Year int
Month int
Day int
}
func (d LocalDate) AsTime(zone *time.Location) time.Time
AsTime converts d into a specific time instance at midnight in zone.
func (d LocalDate) MarshalText() ([]byte, error)
MarshalText returns RFC 3339 representation of d.
func (d LocalDate) String() string
String returns RFC 3339 representation of d.
func (d *LocalDate) UnmarshalText(b []byte) error
UnmarshalText parses b using RFC 3339 to fill d.
LocalDateTime represents a time of a specific day in no specific timezone.
type LocalDateTime struct {
LocalDate
LocalTime
}
func (d LocalDateTime) AsTime(zone *time.Location) time.Time
AsTime converts d into a specific time instance in zone.
func (d LocalDateTime) MarshalText() ([]byte, error)
MarshalText returns RFC 3339 representation of d.
func (d LocalDateTime) String() string
String returns RFC 3339 representation of d.
func (d *LocalDateTime) UnmarshalText(data []byte) error
UnmarshalText parses b using RFC 3339 to fill d.
LocalTime represents a time of day of no specific day in no specific timezone.
type LocalTime struct {
Hour int // Hour of the day: [0; 24[
Minute int // Minute of the hour: [0; 60[
Second int // Second of the minute: [0; 60[
Nanosecond int // Nanoseconds within the second: [0, 1000000000[
Precision int // Number of digits to display for Nanosecond.
}
func (d LocalTime) MarshalText() ([]byte, error)
MarshalText returns RFC 3339 representation of d.
func (d LocalTime) String() string
String returns RFC 3339 representation of d. If d.Nanosecond and d.Precision are zero, the time won't have a nanosecond component. If d.Nanosecond > 0 but d.Precision = 0, then the minimum number of digits for nanoseconds is provided.
func (d *LocalTime) UnmarshalText(b []byte) error
UnmarshalText parses b using RFC 3339 to fill d.
StrictMissingError occurs in a TOML document that does not have a corresponding field in the target value. It contains all the missing fields in Errors.
Emitted by Decoder when DisallowUnknownFields() was called.
type StrictMissingError struct {
// One error per field that could not be found.
Errors []DecodeError
}
func (s *StrictMissingError) Error() string
Error returns the canonical string for this error.
func (s *StrictMissingError) String() string
String returns a human readable description of all errors.
| Name | Synopsis |
|---|---|
| .. | |
| cmd | |
| gotoml-test-decoder | |
| gotoml-test-encoder | |
| jsontoml | Package jsontoml is a program that converts JSON to TOML. |
| tomljson | Package tomljson is a program that converts TOML to JSON. |
| tomll | Package tomll is a linter program for TOML. |
| tomltestgen | tomltestgen retrieves a given version of the language-agnostic TOML test suite in https://github.com/BurntSushi/toml-test and generates go-toml unit tests. |
| ossfuzz | |
| unstable | Package unstable provides APIs that do not meet the backward compatibility guarantees yet. |