Documentation
¶
Overview ¶
Package parser implements a parser for TOML, as defined by the TOML v1 specification https://toml.io/en/v1.0.0.
Unlike other TOML libraries, this parser does not unmarshal into Go values, but only constructs an abstract syntax tree for its input. This is meant to support manipulating the structure of a TOML document.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CleanTrailer ¶ added in v0.0.11
CleanTrailer returns a copy of s that is suitable for use as a line-ending comment. It removes leading and trailing whitespace and prepends a "#" marker if necessary. If s contains newlines, they are converted to spaces.
Types ¶
type ArrayItem ¶
type ArrayItem interface {
// contains filtered or unexported methods
}
An ArrayItem is an element in a TOML array value. The concrete type of an ArrayItem is one of Comments or Value.
type Comments ¶
type Comments []string
Comments is an Item that represents a block of comments. Each entry represents a single comment line.
Comment lines parsed from a source file include the comment marker at the beginning. When constructing comments programmatically, the comment marker is optional; one will be prepended if it does not exist.
func (Comments) Clean ¶ added in v0.0.11
Clean returns a copy of c in which each line has been "cleaned", removing leading and trailing whitespace and prepending a "#" marker to each line that does not already have one. If a line includes embedded newlines, it is split into multiple lines, each of which is cleaned.
type Datum ¶
type Datum interface {
String() string
// contains filtered or unexported methods
}
A Datum is the representation of a data value. The concrete type of a Datum is one of Token, Array, or Inline.
type Heading ¶
type Heading struct {
Block Comments // a block comment before the heading (empty if none)
Trailer string // a trailing line comment after the heading (empty if none)
IsArray bool // whether this table is part of a table array
Name Key // the name of the table
Line int // the input line where the heading was defined (1-based)
}
Heading is an Item that represents a table section heading.
type Item ¶
type Item interface {
// contains filtered or unexported methods
}
An Item is an element in a TOML document. The concrete type of an Item is one of Comments, Heading, or KeyValue.
type Key ¶
type Key []string
A Key represents a dotted compound name.
func (Key) IsPrefixOf ¶
IsPrefixOf reports whether k is a prefix of k2.
type KeyValue ¶
type KeyValue struct {
Block Comments // a block comment before the key-value pair (empty if none)
Name Key
Value Value
Line int // the input line where the key-value was defined (1-based)
}
KeyValue is an Item that represents a key-value definition.
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
A Parser is a parser for TOML syntax.
type Token ¶
type Token struct {
Type scanner.Token // the lexical type of the token
// contains filtered or unexported fields
}
A Token represents a lexical data element such as a string, integer, floating point literal, Boolean, or date/time literal.
type Value ¶
type Value struct {
Trailer string // a trailing line-comment after the value (empty if none)
X Datum // the concrete value
Line int // the input line where the value is defined (1-based)
}
A Value represents a value in an array or a key-value assignment.
func MustValue ¶
MustValue parses s as a TOML value. It panics if parsing fails. This is intended for use at program initialization time, or for static string constants that are expected to be always valid. For all other cases, use ParseValue to check the error.
func (Value) WithComment ¶ added in v0.0.4
WithComment returns a copy of v with its trailer set to text.
Source Files