Documentation
¶
Index ¶
- Variables
- func DeleteAllInContainer(container *cst.Node)
- func Get[T any](doc *Document, key string) (T, error)
- func GetFromContainer[T any](doc *Document, container *cst.Node, key string) (T, error)
- func GetRawFromContainer(doc *Document, container *cst.Node, key string) (any, error)
- func GetStringMapFromTable(table *cst.Node) map[string]string
- func IsMultilineStringInContainer(container *cst.Node, key string) bool
- func SubTableKey(table *cst.Node, prefix string) string
- func SubTableKeyInContainer(table *cst.Node, container *cst.Node, prefix string) string
- type Document
- func (doc *Document) AppendArrayTableEntry(key string) *cst.Node
- func (doc *Document) Bytes() []byte
- func (doc *Document) Delete(key string) error
- func (doc *Document) DeleteFromContainer(container *cst.Node, key string) error
- func (doc *Document) EnsureSubTable(prefix, key string) *cst.Node
- func (doc *Document) EnsureSubTableInContainer(container *cst.Node, prefix, key string) *cst.Node
- func (doc *Document) EnsureTable(name string) *cst.Node
- func (doc *Document) FindArrayTableNodes(key string) []*cst.Node
- func (doc *Document) FindNestedArrayTableNodes(parentKey string, parentIndex int, childKey string) []*cst.Node
- func (doc *Document) FindSubTables(prefix string) []*cst.Node
- func (doc *Document) FindSubTablesInContainer(container *cst.Node, prefix string) []*cst.Node
- func (doc *Document) FindTable(name string) *cst.Node
- func (doc *Document) FindTableInContainer(container *cst.Node, key string) *cst.Node
- func (doc *Document) GetComment(key string) string
- func (doc *Document) GetInlineComment(key string) string
- func (doc *Document) Has(key string) bool
- func (doc *Document) HasInContainer(container *cst.Node, key string) bool
- func (doc *Document) IsMultilineString(key string) bool
- func (doc *Document) RemoveArrayTableEntry(node *cst.Node) error
- func (doc *Document) Root() *cst.Node
- func (doc *Document) Set(key string, value any) error
- func (doc *Document) SetComment(key, comment string)
- func (doc *Document) SetInContainer(container *cst.Node, key string, value any) error
- func (doc *Document) SetInlineComment(key, comment string)
- func (doc *Document) SetMultiline(key string, value string) error
- func (doc *Document) SetMultilineInContainer(container *cst.Node, key string, value string) error
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = fmt.Errorf("not found")
Functions ¶
func DeleteAllInContainer ¶
DeleteAllInContainer removes all key-value children from a container node.
func GetFromContainer ¶
GetFromContainer reads a value from a specific table or array-table node.
func GetRawFromContainer ¶
GetRawFromContainer reads a value from a container and returns it as its natural Go type (string, int64, float64, bool, or []any) without requiring a type parameter.
func GetStringMapFromTable ¶
GetStringMapFromTable reads all key-value pairs from a [table] node as a map[string]string. Returns nil if the table has no key-value children.
func IsMultilineStringInContainer ¶
IsMultilineStringInContainer is like IsMultilineString but searches within a specific container node.
func SubTableKey ¶
SubTableKey returns the sub-key portion of a [prefix.key] table header. For a table with header "actions.build", SubTableKey("actions") returns "build".
func SubTableKeyInContainer ¶
SubTableKeyInContainer returns the sub-key portion of a table header scoped to a container. For a table with header "outer.actions.build" inside container "outer", SubTableKeyInContainer("actions") returns "build".
Types ¶
type Document ¶
type Document struct {
// contains filtered or unexported fields
}
func ParseReader ¶
ParseReader parses TOML from an io.Reader into a Document.
func (*Document) AppendArrayTableEntry ¶
AppendArrayTableEntry adds a new [[key]] section after the last existing one, or at the end of the document. Returns the new node.
func (*Document) DeleteFromContainer ¶
DeleteFromContainer removes a key-value pair from a container node.
func (*Document) EnsureSubTable ¶
EnsureSubTable finds or creates a [prefix.key] table section.
func (*Document) EnsureSubTableInContainer ¶
EnsureSubTableInContainer finds or creates a [containerKey.prefix.key] table section, scoped to the container's qualified header.
func (*Document) EnsureTable ¶
EnsureTable finds or creates a [name] table section in the document. Returns the table node.
func (*Document) FindArrayTableNodes ¶
FindArrayTableNodes returns all [[key]] CST nodes in document order. Returns nil if none exist.
func (*Document) FindNestedArrayTableNodes ¶
func (doc *Document) FindNestedArrayTableNodes(parentKey string, parentIndex int, childKey string) []*cst.Node
FindNestedArrayTableNodes returns [[parentKey.childKey]] entries that belong to the parentIndex-th [[parentKey]] entry. In TOML, nested array-of-tables entries belong to the most recently defined parent entry. This method finds all [[parentKey.childKey]] nodes between the parentIndex-th and (parentIndex+1)-th [[parentKey]] nodes in document order.
func (*Document) FindSubTables ¶
FindSubTables returns all [prefix.key] table nodes for a given prefix, along with the sub-key (the part after the prefix dot). For example, FindSubTables("actions") returns tables like [actions.build].
func (*Document) FindSubTablesInContainer ¶
FindSubTablesInContainer returns all [containerKey.prefix.key] table nodes for a given prefix, scoped to the container's qualified header.
func (*Document) FindTable ¶
FindTable returns the [name] table node from the document root, or nil.
func (*Document) FindTableInContainer ¶
FindTableInContainer finds a [container.key] table that belongs to the given container node. It first checks direct children, then searches the document root for qualified table headers.
func (*Document) GetComment ¶
GetComment returns the comment line(s) immediately above the given key. For dotted keys like "server.port", it looks inside the [server] table. Returns empty string if no comment exists above the key.
func (*Document) GetInlineComment ¶
GetInlineComment returns the inline comment on the same line as the given key. Returns empty string if no inline comment exists.
func (*Document) HasInContainer ¶
HasInContainer returns true if the key exists within the given container node.
func (*Document) IsMultilineString ¶
IsMultilineString reports whether the value node for the given key uses multiline string syntax (""" or ”').
func (*Document) RemoveArrayTableEntry ¶
RemoveArrayTableEntry removes a [[key]] section and its body from the document.
func (*Document) SetComment ¶
SetComment sets or replaces the comment line(s) immediately above the given key. The comment should include the "# " prefix. Multi-line comments should be newline-separated (e.g. "# line one\n# line two").
func (*Document) SetInContainer ¶
SetInContainer sets a key-value within a specific table or array-table node.
func (*Document) SetInlineComment ¶
SetInlineComment sets or replaces the inline comment on the given key's line. The comment should include the "# " prefix.
func (*Document) SetMultiline ¶
SetMultiline sets a string value using multiline basic string syntax (""").
Source Files