toml

package

v1.10.0 Latest Latest Go to latest Published: Apr 16, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/akuity/kargo

Links

Documentation ¶

Index ¶

func FormatValue(value any) ([]byte, error)
func FormatValueString(value any) string
func SetValuesInBytes(inBytes []byte, updates []Update) ([]byte, error)
func SetValuesInFile(file string, updates []Update) error
type Update

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatValue ¶

func FormatValue(value any) ([]byte, error)

FormatValue returns a TOML-encoded scalar value.

func FormatValueString ¶

func FormatValueString(value any) string

FormatValueString returns a TOML-encoded scalar value as a string.

func SetValuesInBytes ¶

func SetValuesInBytes(inBytes []byte, updates []Update) ([]byte, error)

SetValuesInBytes returns a copy of the provided bytes with the changes specified by Updates applied. Keys are of the form <key 0>.<key 1>...<key n>. Integers may be used as keys where a specific array element needs to be selected. An error is returned for any attempted update to a key that does not exist or does not address a scalar node. Untouched bytes are preserved.

func SetValuesInFile ¶

func SetValuesInFile(file string, updates []Update) error

SetValuesInFile overwrites the specified file with the changes specified by the list of Updates. Keys are of the form <key 0>.<key 1>...<key n>. Integers may be used as keys where a specific array element needs to be selected. An error is returned for any attempted update to a key that does not exist or does not address a scalar node. Untouched bytes are preserved.

Types ¶

type Update ¶

type Update struct {
	// Key is the dot-separated path to the field to update.
	Key string
	// Value is the new value to set for the field.
	Value any
}

Update represents a discrete update to be made to a TOML document.

Source Files ¶

View all Source files

toml.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL