go-toml: github.com/pelletier/go-toml Index | Examples | Files | Directories

package toml

import "github.com/pelletier/go-toml"

Package toml is a TOML parser and manipulation library.

This version supports the specification as described in https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md

Marshaling

Go-toml can marshal and unmarshal TOML documents from and to data structures.

TOML document as a tree

Go-toml can operate on a TOML document as a tree. Use one of the Load* functions to parse TOML data and obtain a Tree instance, then one of its methods to manipulate the tree.

JSONPath-like queries

The package github.com/pelletier/go-toml/query implements a system similar to JSONPath to quickly retrieve elements of a TOML document using a single expression. See the package documentation for more information.

Package civil implements types for civil time, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.

Because they lack location information, these types do not represent unique moments or intervals of time. Use time.Time for that purpose.

Code:

config, err := toml.LoadFile("config.toml")

if err != nil {
    fmt.Println("Error ", err.Error())
} else {
    // retrieve data directly
    directUser := config.Get("postgres.user").(string)
    directPassword := config.Get("postgres.password").(string)
    fmt.Println("User is", directUser, " and password is", directPassword)

    // or using an intermediate object
    configTree := config.Get("postgres").(*toml.Tree)
    user := configTree.Get("user").(string)
    password := configTree.Get("password").(string)
    fmt.Println("User is", user, " and password is", password)

    // show where elements are in the file
    fmt.Printf("User position: %v\n", configTree.GetPosition("user"))
    fmt.Printf("Password position: %v\n", configTree.GetPosition("password"))
}

Code:

type Employer struct {
    Name  string
    Phone string
}
type Person struct {
    Name     string
    Age      int64
    Employer Employer
}

document := []byte(`
	name = "John"
	age = 30
	[employer]
		name = "Company Inc."
		phone = "+1 234 567 89012"
	`)

person := Person{}
toml.Unmarshal(document, &person)
fmt.Println(person.Name, "is", person.Age, "and works at", person.Employer.Name)

Output:

John is 30 and works at Company Inc.

Index

Examples

Package Files

doc.go keysparsing.go lexer.go localtime.go marshal.go parser.go position.go token.go toml.go tomltree_create.go tomltree_write.go

Constants

const (
    // Sort fields alphabetically.
    OrderAlphabetical marshalOrder = iota + 1
    // Preserve the order the fields are encountered. For example, the order of fields in
    // a struct.
    OrderPreserve
)

Orders the Encoder can write the fields to the output stream.

func Marshal Uses

func Marshal(v interface{}) ([]byte, error)

Marshal returns the TOML encoding of v. Behavior is similar to the Go json encoder, except that there is no concept of a Marshaler interface or MarshalTOML function for sub-structs, and currently only definite types can be marshaled (i.e. no `interface{}`).

The following struct annotations are supported:

toml:"Field"      Overrides the field's name to output.
omitempty         When set, empty values and groups are not emitted.
comment:"comment" Emits a # comment on the same line. This supports new lines.
commented:"true"  Emits the value as commented.

Note that pointers are automatically assigned the "omitempty" option, as TOML explicitly does not handle null values (saying instead the label should be dropped).

Tree structural types and corresponding marshal types:

*Tree                            (*)struct, (*)map[string]interface{}
[]*Tree                          (*)[](*)struct, (*)[](*)map[string]interface{}
[]interface{} (as interface{})   (*)[]primitive, (*)[]([]interface{})
interface{}                      (*)primitive

Tree primitive types and corresponding marshal types:

uint64     uint, uint8-uint64, pointers to same
int64      int, int8-uint64, pointers to same
float64    float32, float64, pointers to same
string     string, pointers to same
bool       bool, pointers to same
time.LocalTime  time.LocalTime{}, pointers to same

For additional flexibility, use the Encoder API.

Code:

type Postgres struct {
    User     string `toml:"user"`
    Password string `toml:"password"`
    Database string `toml:"db" commented:"true" comment:"not used anymore"`
}
type Config struct {
    Postgres Postgres `toml:"postgres" comment:"Postgres configuration"`
}

config := Config{Postgres{User: "pelletier", Password: "mypassword", Database: "old_database"}}
b, err := toml.Marshal(config)
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(b))

Output:

# Postgres configuration
[postgres]

  # not used anymore
  # db = "old_database"
  password = "mypassword"
  user = "pelletier"

func Unmarshal Uses

func Unmarshal(data []byte, v interface{}) error

Unmarshal parses the TOML-encoded data and stores the result in the value pointed to by v. Behavior is similar to the Go json encoder, except that there is no concept of an Unmarshaler interface or UnmarshalTOML function for sub-structs, and currently only definite types can be unmarshaled to (i.e. no `interface{}`).

The following struct annotations are supported:

toml:"Field" Overrides the field's name to map to.
default:"foo" Provides a default value.

For default values, only fields of the following types are supported:

* string
* bool
* int
* int64
* float64

See Marshal() documentation for types mapping table.

Code:

type Postgres struct {
    User     string
    Password string
}
type Config struct {
    Postgres Postgres
}

doc := []byte(`
	[postgres]
	user = "pelletier"
	password = "mypassword"`)

config := Config{}
toml.Unmarshal(doc, &config)
fmt.Println("user=", config.Postgres.User)

Output:

user= pelletier

type Decoder Uses

type Decoder struct {
    // contains filtered or unexported fields
}

Decoder reads and decodes TOML values from an input stream.

func NewDecoder Uses

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new decoder that reads from r.

func (*Decoder) Decode Uses

func (d *Decoder) Decode(v interface{}) error

Decode reads a TOML-encoded value from it's input and unmarshals it in the value pointed at by v.

See the documentation for Marshal for details.

func (*Decoder) SetTagName Uses

func (d *Decoder) SetTagName(v string) *Decoder

SetTagName allows changing default tag "toml"

func (*Decoder) Strict Uses

func (d *Decoder) Strict(strict bool) *Decoder

Strict allows changing to strict decoding. Any fields that are found in the input data and do not have a corresponding struct member cause an error.

type Encoder Uses

type Encoder struct {
    // contains filtered or unexported fields
}

Encoder writes TOML values to an output stream.

Code:

type Credentials struct {
    User     string `toml:"user"`
    Password string `toml:"password"`
}

type Protocol struct {
    Name string `toml:"name"`
}

type Config struct {
    Version int `toml:"version"`
    Credentials
    Protocol `toml:"Protocol"`
}
config := Config{
    Version: 2,
    Credentials: Credentials{
        User:     "pelletier",
        Password: "mypassword",
    },
    Protocol: Protocol{
        Name: "tcp",
    },
}
fmt.Println("Default:")
fmt.Println("---------------")

def := toml.NewEncoder(os.Stdout)
if err := def.Encode(config); err != nil {
    log.Fatal(err)
}

fmt.Println("---------------")
fmt.Println("With promotion:")
fmt.Println("---------------")

prom := toml.NewEncoder(os.Stdout).PromoteAnonymous(true)
if err := prom.Encode(config); err != nil {
    log.Fatal(err)
}

Output:

Default:
---------------
password = "mypassword"
user = "pelletier"
version = 2

[Protocol]
  name = "tcp"
---------------
With promotion:
---------------
version = 2

[Credentials]
  password = "mypassword"
  user = "pelletier"

[Protocol]
  name = "tcp"

func NewEncoder Uses

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new encoder that writes to w.

func (*Encoder) ArraysWithOneElementPerLine Uses

func (e *Encoder) ArraysWithOneElementPerLine(v bool) *Encoder

ArraysWithOneElementPerLine sets up the encoder to encode arrays with more than one element on multiple lines instead of one.

For example:

A = [1,2,3]

Becomes

A = [
  1,
  2,
  3,
]

func (*Encoder) Encode Uses

func (e *Encoder) Encode(v interface{}) error

Encode writes the TOML encoding of v to the stream.

See the documentation for Marshal for details.

func (*Encoder) Indentation Uses

func (e *Encoder) Indentation(indent string) *Encoder

Indentation allows to change indentation when marshalling.

func (*Encoder) Order Uses

func (e *Encoder) Order(ord marshalOrder) *Encoder

Order allows to change in which order fields will be written to the output stream.

func (*Encoder) PromoteAnonymous Uses

func (e *Encoder) PromoteAnonymous(promote bool) *Encoder

PromoteAnonymous allows to change how anonymous struct fields are marshaled. Usually, they are marshaled as if the inner exported fields were fields in the outer struct. However, if an anonymous struct field is given a name in its TOML tag, it is treated like a regular struct field with that name. rather than being anonymous.

In case anonymous promotion is enabled, all anonymous structs are promoted and treated like regular struct fields.

func (*Encoder) QuoteMapKeys Uses

func (e *Encoder) QuoteMapKeys(v bool) *Encoder

QuoteMapKeys sets up the encoder to encode maps with string type keys with quoted TOML keys.

This relieves the character limitations on map keys.

func (*Encoder) SetTagComment Uses

func (e *Encoder) SetTagComment(v string) *Encoder

SetTagComment allows changing default tag "comment"

func (*Encoder) SetTagCommented Uses

func (e *Encoder) SetTagCommented(v string) *Encoder

SetTagCommented allows changing default tag "commented"

func (*Encoder) SetTagMultiline Uses

func (e *Encoder) SetTagMultiline(v string) *Encoder

SetTagMultiline allows changing default tag "multiline"

func (*Encoder) SetTagName Uses

func (e *Encoder) SetTagName(v string) *Encoder

SetTagName allows changing default tag "toml"

type LocalDate Uses

type LocalDate struct {
    Year  int        // Year (e.g., 2014).
    Month time.Month // Month of the year (January = 1, ...).
    Day   int        // Day of the month, starting at 1.
}

A LocalDate represents a date (year, month, day).

This type does not include location information, and therefore does not describe a unique 24-hour timespan.

func LocalDateOf Uses

func LocalDateOf(t time.Time) LocalDate

LocalDateOf returns the LocalDate in which a time occurs in that time's location.

func ParseLocalDate Uses

func ParseLocalDate(s string) (LocalDate, error)

ParseLocalDate parses a string in RFC3339 full-date format and returns the date value it represents.

func (LocalDate) AddDays Uses

func (d LocalDate) AddDays(n int) LocalDate

AddDays returns the date that is n days in the future. n can also be negative to go into the past.

func (LocalDate) After Uses

func (d1 LocalDate) After(d2 LocalDate) bool

After reports whether d1 occurs after d2.

func (LocalDate) Before Uses

func (d1 LocalDate) Before(d2 LocalDate) bool

Before reports whether d1 occurs before d2.

func (LocalDate) DaysSince Uses

func (d LocalDate) DaysSince(s LocalDate) (days int)

DaysSince returns the signed number of days between the date and s, not including the end day. This is the inverse operation to AddDays.

func (LocalDate) In Uses

func (d LocalDate) In(loc *time.Location) time.Time

In returns the time corresponding to time 00:00:00 of the date in the location.

In is always consistent with time.LocalDate, even when time.LocalDate returns a time on a different day. For example, if loc is America/Indiana/Vincennes, then both

time.LocalDate(1955, time.May, 1, 0, 0, 0, 0, loc)

and

civil.LocalDate{Year: 1955, Month: time.May, Day: 1}.In(loc)

return 23:00:00 on April 30, 1955.

In panics if loc is nil.

func (LocalDate) IsValid Uses

func (d LocalDate) IsValid() bool

IsValid reports whether the date is valid.

func (LocalDate) MarshalText Uses

func (d LocalDate) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface. The output is the result of d.String().

func (LocalDate) String Uses

func (d LocalDate) String() string

String returns the date in RFC3339 full-date format.

func (*LocalDate) UnmarshalText Uses

func (d *LocalDate) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface. The date is expected to be a string in a format accepted by ParseLocalDate.

type LocalDateTime Uses

type LocalDateTime struct {
    Date LocalDate
    Time LocalTime
}

A LocalDateTime represents a date and time.

This type does not include location information, and therefore does not describe a unique moment in time.

func LocalDateTimeOf Uses

func LocalDateTimeOf(t time.Time) LocalDateTime

LocalDateTimeOf returns the LocalDateTime in which a time occurs in that time's location.

func ParseLocalDateTime Uses

func ParseLocalDateTime(s string) (LocalDateTime, error)

ParseLocalDateTime parses a string and returns the LocalDateTime it represents. ParseLocalDateTime accepts a variant of the RFC3339 date-time format that omits the time offset but includes an optional fractional time, as described in ParseLocalTime. Informally, the accepted format is

YYYY-MM-DDTHH:MM:SS[.FFFFFFFFF]

where the 'T' may be a lower-case 't'.

func (LocalDateTime) After Uses

func (dt1 LocalDateTime) After(dt2 LocalDateTime) bool

After reports whether dt1 occurs after dt2.

func (LocalDateTime) Before Uses

func (dt1 LocalDateTime) Before(dt2 LocalDateTime) bool

Before reports whether dt1 occurs before dt2.

func (LocalDateTime) In Uses

func (dt LocalDateTime) In(loc *time.Location) time.Time

In returns the time corresponding to the LocalDateTime in the given location.

If the time is missing or ambigous at the location, In returns the same result as time.LocalDate. For example, if loc is America/Indiana/Vincennes, then both

time.LocalDate(1955, time.May, 1, 0, 30, 0, 0, loc)

and

civil.LocalDateTime{
    civil.LocalDate{Year: 1955, Month: time.May, Day: 1}},
    civil.LocalTime{Minute: 30}}.In(loc)

return 23:30:00 on April 30, 1955.

In panics if loc is nil.

func (LocalDateTime) IsValid Uses

func (dt LocalDateTime) IsValid() bool

IsValid reports whether the datetime is valid.

func (LocalDateTime) MarshalText Uses

func (dt LocalDateTime) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface. The output is the result of dt.String().

func (LocalDateTime) String Uses

func (dt LocalDateTime) String() string

String returns the date in the format described in ParseLocalDate.

func (*LocalDateTime) UnmarshalText Uses

func (dt *LocalDateTime) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface. The datetime is expected to be a string in a format accepted by ParseLocalDateTime

type LocalTime Uses

type LocalTime struct {
    Hour       int // The hour of the day in 24-hour format; range [0-23]
    Minute     int // The minute of the hour; range [0-59]
    Second     int // The second of the minute; range [0-59]
    Nanosecond int // The nanosecond of the second; range [0-999999999]
}

A LocalTime represents a time with nanosecond precision.

This type does not include location information, and therefore does not describe a unique moment in time.

This type exists to represent the TIME type in storage-based APIs like BigQuery. Most operations on Times are unlikely to be meaningful. Prefer the LocalDateTime type.

func LocalTimeOf Uses

func LocalTimeOf(t time.Time) LocalTime

LocalTimeOf returns the LocalTime representing the time of day in which a time occurs in that time's location. It ignores the date.

func ParseLocalTime Uses

func ParseLocalTime(s string) (LocalTime, error)

ParseLocalTime parses a string and returns the time value it represents. ParseLocalTime accepts an extended form of the RFC3339 partial-time format. After the HH:MM:SS part of the string, an optional fractional part may appear, consisting of a decimal point followed by one to nine decimal digits. (RFC3339 admits only one digit after the decimal point).

func (LocalTime) IsValid Uses

func (t LocalTime) IsValid() bool

IsValid reports whether the time is valid.

func (LocalTime) MarshalText Uses

func (t LocalTime) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface. The output is the result of t.String().

func (LocalTime) String Uses

func (t LocalTime) String() string

String returns the date in the format described in ParseLocalTime. If Nanoseconds is zero, no fractional part will be generated. Otherwise, the result will end with a fractional part consisting of a decimal point and nine digits.

func (*LocalTime) UnmarshalText Uses

func (t *LocalTime) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface. The time is expected to be a string in a format accepted by ParseLocalTime.

type Marshaler Uses

type Marshaler interface {
    MarshalTOML() ([]byte, error)
}

Marshaler is the interface implemented by types that can marshal themselves into valid TOML.

type Position Uses

type Position struct {
    Line int // line within the document
    Col  int // column within the line
}

Position of a document element within a TOML document.

Line and Col are both 1-indexed positions for the element's line number and column number, respectively. Values of zero or less will cause Invalid(), to return true.

func (Position) Invalid Uses

func (p Position) Invalid() bool

Invalid returns whether or not the position is valid (i.e. with negative or null values)

func (Position) String Uses

func (p Position) String() string

String representation of the position. Displays 1-indexed line and column numbers.

type SetOptions Uses

type SetOptions struct {
    Comment   string
    Commented bool
    Multiline bool
}

SetOptions arguments are supplied to the SetWithOptions and SetPathWithOptions functions to modify marshalling behaviour. The default values within the struct are valid default options.

type Tree Uses

type Tree struct {
    // contains filtered or unexported fields
}

Tree is the result of the parsing of a TOML file.

func Load Uses

func Load(content string) (tree *Tree, err error)

Load creates a Tree from a string.

func LoadBytes Uses

func LoadBytes(b []byte) (tree *Tree, err error)

LoadBytes creates a Tree from a []byte.

func LoadFile Uses

func LoadFile(path string) (tree *Tree, err error)

LoadFile creates a Tree from a file.

func LoadReader Uses

func LoadReader(reader io.Reader) (tree *Tree, err error)

LoadReader creates a Tree from any io.Reader.

func TreeFromMap Uses

func TreeFromMap(m map[string]interface{}) (*Tree, error)

TreeFromMap initializes a new Tree object using the given map.

func (*Tree) Delete Uses

func (t *Tree) Delete(key string) error

Delete removes a key from the tree. Key is a dot-separated path (e.g. a.b.c).

func (*Tree) DeletePath Uses

func (t *Tree) DeletePath(keys []string) error

DeletePath removes a key from the tree. Keys is an array of path elements (e.g. {"a","b","c"}).

func (*Tree) Get Uses

func (t *Tree) Get(key string) interface{}

Get the value at key in the Tree. Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings. If you need to retrieve non-bare keys, use GetPath. Returns nil if the path does not exist in the tree. If keys is of length zero, the current tree is returned.

func (*Tree) GetArray Uses

func (t *Tree) GetArray(key string) interface{}

GetArray returns the value at key in the Tree. It returns []string, []int64, etc type if key has homogeneous lists Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings. Returns nil if the path does not exist in the tree. If keys is of length zero, the current tree is returned.

func (*Tree) GetArrayPath Uses

func (t *Tree) GetArrayPath(keys []string) interface{}

GetArrayPath returns the element in the tree indicated by 'keys'. If keys is of length zero, the current tree is returned.

func (*Tree) GetDefault Uses

func (t *Tree) GetDefault(key string, def interface{}) interface{}

GetDefault works like Get but with a default value

func (*Tree) GetPath Uses

func (t *Tree) GetPath(keys []string) interface{}

GetPath returns the element in the tree indicated by 'keys'. If keys is of length zero, the current tree is returned.

func (*Tree) GetPosition Uses

func (t *Tree) GetPosition(key string) Position

GetPosition returns the position of the given key.

func (*Tree) GetPositionPath Uses

func (t *Tree) GetPositionPath(keys []string) Position

GetPositionPath returns the element in the tree indicated by 'keys'. If keys is of length zero, the current tree is returned.

func (*Tree) Has Uses

func (t *Tree) Has(key string) bool

Has returns a boolean indicating if the given key exists.

func (*Tree) HasPath Uses

func (t *Tree) HasPath(keys []string) bool

HasPath returns true if the given path of keys exists, false otherwise.

func (*Tree) Keys Uses

func (t *Tree) Keys() []string

Keys returns the keys of the toplevel tree (does not recurse).

func (*Tree) Marshal Uses

func (t *Tree) Marshal() ([]byte, error)

Marshal returns the TOML encoding of Tree. See Marshal() documentation for types mapping table.

func (*Tree) Position Uses

func (t *Tree) Position() Position

Position returns the position of the tree.

func (*Tree) Set Uses

func (t *Tree) Set(key string, value interface{})

Set an element in the tree. Key is a dot-separated path (e.g. a.b.c). Creates all necessary intermediate trees, if needed.

func (*Tree) SetPath Uses

func (t *Tree) SetPath(keys []string, value interface{})

SetPath sets an element in the tree. Keys is an array of path elements (e.g. {"a","b","c"}). Creates all necessary intermediate trees, if needed.

func (*Tree) SetPathWithComment Uses

func (t *Tree) SetPathWithComment(keys []string, comment string, commented bool, value interface{})

SetPathWithComment is the same as SetPath, but allows you to provide comment information to the key, that will be reused by Marshal().

func (*Tree) SetPathWithOptions Uses

func (t *Tree) SetPathWithOptions(keys []string, opts SetOptions, value interface{})

SetPathWithOptions is the same as SetPath, but allows you to provide formatting instructions to the key, that will be reused by Marshal().

func (*Tree) SetPositionPath Uses

func (t *Tree) SetPositionPath(keys []string, pos Position)

SetPositionPath sets the position of element in the tree indicated by 'keys'. If keys is of length zero, the current tree position is set.

func (*Tree) SetWithComment Uses

func (t *Tree) SetWithComment(key string, comment string, commented bool, value interface{})

SetWithComment is the same as Set, but allows you to provide comment information to the key, that will be reused by Marshal().

func (*Tree) SetWithOptions Uses

func (t *Tree) SetWithOptions(key string, opts SetOptions, value interface{})

SetWithOptions is the same as Set, but allows you to provide formatting instructions to the key, that will be used by Marshal().

func (*Tree) String Uses

func (t *Tree) String() string

String generates a human-readable representation of the current tree. Alias of ToString. Present to implement the fmt.Stringer interface.

func (*Tree) ToMap Uses

func (t *Tree) ToMap() map[string]interface{}

ToMap recursively generates a representation of the tree using Go built-in structures. The following types are used:

* bool
* float64
* int64
* string
* uint64
* time.Time
* map[string]interface{} (where interface{} is any of this list)
* []interface{} (where interface{} is any of this list)

func (*Tree) ToTomlString Uses

func (t *Tree) ToTomlString() (string, error)

ToTomlString generates a human-readable representation of the current tree. Output spans multiple lines, and is suitable for ingest by a TOML parser. If the conversion cannot be performed, ToString returns a non-nil error.

func (*Tree) Unmarshal Uses

func (t *Tree) Unmarshal(v interface{}) error

Unmarshal attempts to unmarshal the Tree into a Go struct pointed by v. Neither Unmarshaler interfaces nor UnmarshalTOML functions are supported for sub-structs, and only definite types can be unmarshaled.

func (*Tree) WriteTo Uses

func (t *Tree) WriteTo(w io.Writer) (int64, error)

WriteTo encode the Tree as Toml and writes it to the writer w. Returns the number of bytes written in case of success, or an error if anything happened.

type Unmarshaler Uses

type Unmarshaler interface {
    UnmarshalTOML(interface{}) error
}

Unmarshaler is the interface implemented by types that can unmarshal a TOML description of themselves.

Directories

PathSynopsis
cmd/jsontomlJsontoml reads JSON and converts to TOML.
cmd/tomljsonTomljson reads TOML and converts to JSON.
cmd/tomllTomll is a linter for TOML
cmd/tomltestgenTomltestgen is a program that retrieves a given version of https://github.com/BurntSushi/toml-test and generates go code for go-toml's unit tests based on the test files.
queryPackage query performs JSONPath-like queries on a TOML document.

Package toml imports 16 packages (graph) and is imported by 558 packages. Updated 2020-08-01. Refresh now. Tools for package owners.